Skip to content

Commit a1ba92a

Browse files
better format
1 parent ef6d57a commit a1ba92a

File tree

1 file changed

+18
-32
lines changed

1 file changed

+18
-32
lines changed

docs/source/conf.py

Lines changed: 18 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,12 @@
11
import os
22
import sys
33
sys.path.insert(0, os.path.abspath('../..'))
4-
5-
# Configuration file for the Sphinx documentation builder.
6-
#
7-
# For the full list of built-in configuration values, see the documentation:
8-
# https://www.sphinx-doc.org/en/master/usage/configuration.html
9-
10-
# -- Project information -----------------------------------------------------
11-
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
12-
134
project = 'manify'
145
copyright = '2025, Philippe Chlenski and Kaizhu Du'
156
author = 'Philippe Chlenski and Kaizhu Du'
167
release = '0.0.2'
178

18-
# -- General configuration ---------------------------------------------------
19-
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
209

21-
# extensions = [
22-
# 'sphinx.ext.autodoc',
23-
# 'sphinx.ext.napoleon',
24-
# 'sphinx_autodoc_typehints',
25-
# 'sphinx.ext.autosummary',
26-
# 'autoapi.extension',
27-
# ]
2810
extensions = [
2911
'sphinx.ext.napoleon',
3012
# 'sphinx_autodoc_typehints',
@@ -33,24 +15,28 @@
3315
# 'sphinx.ext.autosummary',
3416
]
3517

36-
# autosummary_generate = True
37-
# autodoc_default_options = {
38-
# "members": True,
39-
# "undoc-members": True,
40-
# "show-inheritance": True,
41-
# }
42-
4318
autoapi_type = 'python'
4419
autoapi_dirs = [os.path.abspath('../../manify')]
4520
autoapi_ignore = ["*/utils/*"]
46-
autodoc_typehints = "description"
21+
4722
templates_path = ['_templates']
4823
exclude_patterns = []
4924

50-
51-
52-
# -- Options for HTML output -------------------------------------------------
53-
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
54-
55-
html_theme = 'sphinx_rtd_theme'
25+
autodoc_default_options = {
26+
"members": True,
27+
"undoc-members": False, # Set to False to hide undocumented members
28+
"private-members": False,
29+
"show-inheritance": True,
30+
"exclude-members": "__init__",
31+
}
32+
autoclass_content = "class"
33+
autoapi_options = [
34+
"members", # pull in documented members
35+
"imported-members", # if you want to re-export things
36+
"show-inheritance",
37+
# note: NO 'undoc-members' here
38+
]
39+
autodoc_typehints = "description"
40+
html_theme = "sphinx_rtd_theme"
5641
html_static_path = ['_static']
42+

0 commit comments

Comments
 (0)