|
1 | 1 | import os |
2 | 2 | import sys |
3 | 3 | 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 | | - |
13 | 4 | project = 'manify' |
14 | 5 | copyright = '2025, Philippe Chlenski and Kaizhu Du' |
15 | 6 | author = 'Philippe Chlenski and Kaizhu Du' |
16 | 7 | release = '0.0.2' |
17 | 8 |
|
18 | | -# -- General configuration --------------------------------------------------- |
19 | | -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
20 | 9 |
|
21 | | -# extensions = [ |
22 | | -# 'sphinx.ext.autodoc', |
23 | | -# 'sphinx.ext.napoleon', |
24 | | -# 'sphinx_autodoc_typehints', |
25 | | -# 'sphinx.ext.autosummary', |
26 | | -# 'autoapi.extension', |
27 | | -# ] |
28 | 10 | extensions = [ |
29 | 11 | 'sphinx.ext.napoleon', |
30 | 12 | # 'sphinx_autodoc_typehints', |
|
33 | 15 | # 'sphinx.ext.autosummary', |
34 | 16 | ] |
35 | 17 |
|
36 | | -# autosummary_generate = True |
37 | | -# autodoc_default_options = { |
38 | | -# "members": True, |
39 | | -# "undoc-members": True, |
40 | | -# "show-inheritance": True, |
41 | | -# } |
42 | | - |
43 | 18 | autoapi_type = 'python' |
44 | 19 | autoapi_dirs = [os.path.abspath('../../manify')] |
45 | 20 | autoapi_ignore = ["*/utils/*"] |
46 | | -autodoc_typehints = "description" |
| 21 | + |
47 | 22 | templates_path = ['_templates'] |
48 | 23 | exclude_patterns = [] |
49 | 24 |
|
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" |
56 | 41 | html_static_path = ['_static'] |
| 42 | + |
0 commit comments