Skip to content

Commit 62a24d4

Browse files
committed
Clean up sphinx settings
1 parent a2fd43c commit 62a24d4

File tree

1 file changed

+11
-46
lines changed

1 file changed

+11
-46
lines changed

docs/source/conf.py

Lines changed: 11 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,20 @@
11
import os
2-
import sys
3-
sys.path.insert(0, os.path.abspath('../..'))
4-
project = 'manify'
5-
copyright = '2025, Philippe Chlenski and Kaizhu Du'
6-
author = 'Philippe Chlenski and Kaizhu Du'
7-
release = '0.0.2'
82

3+
project = "manify"
4+
copyright = "2025, Philippe Chlenski and Kaizhu Du"
5+
author = "Philippe Chlenski and Kaizhu Du"
6+
release = "0.0.2"
97

10-
extensions = [
11-
'sphinx.ext.napoleon',
12-
# 'sphinx_autodoc_typehints',
13-
'autoapi.extension',
14-
# 'sphinx.ext.autodoc',
15-
# 'sphinx.ext.autosummary',
16-
]
17-
napoleon_use_rtype = False
18-
19-
autoapi_type = 'python'
20-
autoapi_dirs = [os.path.abspath('../../manify')]
8+
extensions = ["sphinx.ext.napoleon", "autoapi.extension"]
219

10+
napoleon_use_rtype = False
2211

23-
# autoapi_ignore = ["*/utils/*"]
12+
autoapi_type = "python"
13+
autoapi_dirs = [os.path.abspath("../../manify")]
14+
autoapi_options = ["members", "undoc-members", "imported-members", "show-inheritance", "show-module-summary"]
2415

25-
templates_path = ['_templates']
16+
templates_path = ["_templates"]
2617
exclude_patterns = []
2718

28-
autodoc_default_options = {
29-
"members": True,
30-
"undoc-members": False, # Set to False to hide undocumented members
31-
"private-members": False,
32-
"show-inheritance": True,
33-
"exclude-members": "__init__",
34-
}
35-
autoclass_content = "class"
36-
autoapi_options = [
37-
"members",
38-
"undoc-members",
39-
"imported-members",
40-
"show-inheritance",
41-
"show-module-summary",
42-
]
43-
44-
# conf.py
45-
rst_epilog = """
46-
.. |---| replace:: ------------
47-
"""
48-
4919
html_theme = "sphinx_rtd_theme"
50-
html_static_path = ['_static']
51-
autodoc_typehints = "none"
52-
53-
rst_epilog = """
54-
.. |K| replace:: :math:`K` # Example: Render K as a math symbol
55-
"""
20+
html_static_path = ["_static"]

0 commit comments

Comments
 (0)