Skip to content

Commit 2f7aa99

Browse files
docs: Update Sphinx configuration to improve docstring generation and module documentation
1 parent 4d6e16f commit 2f7aa99

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

docs/source/api.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,22 @@ Core Module
1010
:show-inheritance:
1111
:private-members:
1212
:special-members:
13+
:imported-members:
1314

1415
Utility Modules
1516
-------------
1617

18+
Interactive Utilities
19+
~~~~~~~~~~~~~~~~~~~
20+
21+
.. automodule:: wdoc.utils.interact
22+
:members:
23+
:undoc-members:
24+
:show-inheritance:
25+
:private-members:
26+
:special-members:
27+
:imported-members:
28+
1729
Miscellaneous Utilities
1830
~~~~~~~~~~~~~~~~~~~~~~
1931

@@ -23,6 +35,7 @@ Miscellaneous Utilities
2335
:show-inheritance:
2436
:private-members:
2537
:special-members:
38+
:imported-members:
2639

2740
Logger
2841
~~~~~~
@@ -33,6 +46,7 @@ Logger
3346
:show-inheritance:
3447
:private-members:
3548
:special-members:
49+
:imported-members:
3650

3751
LLM Utilities
3852
~~~~~~~~~~~~
@@ -43,3 +57,4 @@ LLM Utilities
4357
:show-inheritance:
4458
:private-members:
4559
:special-members:
60+
:imported-members:

docs/source/conf.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@
88

99
import os
1010
import sys
11+
12+
# Add the project root and extension directories to the Python path
1113
sys.path.insert(0, os.path.abspath('_ext'))
1214
sys.path.insert(0, os.path.abspath('../..'))
15+
sys.path.insert(0, os.path.abspath('../../wdoc'))
1316

1417
project = 'wdoc'
1518
copyright = '2024, thiswillbeyourgithub'
@@ -36,8 +39,15 @@
3639
'private-members': True,
3740
'special-members': True,
3841
'show-inheritance': True,
42+
'imported-members': True,
3943
}
4044

45+
autodoc_member_order = 'bysource'
46+
autodoc_typehints = 'description'
47+
autodoc_preserve_defaults = True
48+
autodoc_inherit_docstrings = True
49+
autodoc_docstring_signature = True
50+
4151
# Napoleon settings
4252
napoleon_google_docstring = True
4353
napoleon_numpy_docstring = True

0 commit comments

Comments
 (0)