|
10 | 10 | sys.path.append(os.path.abspath('.')) |
11 | 11 | sys.path.append(os.path.abspath('..')) |
12 | 12 |
|
| 13 | +# 3rd party |
| 14 | +import domdf_python_tools |
| 15 | + |
| 16 | +# this package |
13 | 17 | from __pkginfo__ import __version__ |
14 | 18 |
|
15 | | -# User-configurable lines |
16 | | -import domdf_python_tools |
17 | 19 | domdf_python_tools.__docs = True |
18 | 20 | overloads_location = "bottom" |
19 | | -# End of user-configurable lines |
20 | 21 |
|
21 | 22 | github_username = "domdfcoding" |
22 | 23 | github_repository = "domdf_python_tools" |
23 | 24 | github_url = f"https://github.com/{github_username}/{github_repository}" |
24 | 25 |
|
25 | | - |
26 | 26 | rst_prolog = f""".. |pkgname| replace:: domdf_python_tools |
27 | 27 | .. |pkgname2| replace:: ``domdf_python_tools`` |
28 | 28 | .. |browse_github| replace:: `Browse the GitHub Repository <{github_url}>`__ |
|
37 | 37 | package_root = "domdf_python_tools" |
38 | 38 |
|
39 | 39 | extensions = [ |
40 | | - 'sphinx_toolbox', |
41 | | - 'sphinx_toolbox.more_autodoc', |
42 | | - 'sphinx_toolbox.more_autosummary', |
43 | | - 'sphinx_toolbox.tweaks.param_dash', |
44 | | - 'sphinx.ext.intersphinx', |
45 | | - 'sphinx.ext.mathjax', |
46 | | - 'sphinxcontrib.httpdomain', |
47 | | - 'sphinxcontrib.extras_require', |
48 | | - 'sphinx.ext.todo', |
49 | | - 'sphinxemoji.sphinxemoji', |
50 | | - 'notfound.extension', |
51 | | - 'sphinx_copybutton', |
52 | | - 'sphinxcontrib.default_values', |
53 | | - 'sphinxcontrib.toctree_plus', |
54 | | - 'seed_intersphinx_mapping', |
55 | | - ] |
| 40 | + 'sphinx_toolbox', |
| 41 | + 'sphinx_toolbox.more_autodoc', |
| 42 | + 'sphinx_toolbox.more_autosummary', |
| 43 | + 'sphinx_toolbox.tweaks.param_dash', |
| 44 | + 'sphinx.ext.intersphinx', |
| 45 | + 'sphinx.ext.mathjax', |
| 46 | + 'sphinxcontrib.httpdomain', |
| 47 | + 'sphinxcontrib.extras_require', |
| 48 | + 'sphinx.ext.todo', |
| 49 | + 'sphinxemoji.sphinxemoji', |
| 50 | + 'notfound.extension', |
| 51 | + 'sphinx_copybutton', |
| 52 | + 'sphinxcontrib.default_values', |
| 53 | + 'sphinxcontrib.toctree_plus', |
| 54 | + 'seed_intersphinx_mapping', |
| 55 | + ] |
56 | 56 |
|
57 | 57 | sphinxemoji_style = 'twemoji' |
58 | 58 | todo_include_todos = bool(os.environ.get("SHOW_TODOS", 0)) |
|
113 | 113 | } |
114 | 114 |
|
115 | 115 | add_module_names = False |
116 | | - |
117 | | - |
| 116 | +hide_none_rtype = True |
| 117 | + |
| 118 | + |
| 119 | +autodoc_exclude_members = [ # Exclude "standard" methods. |
| 120 | + "__dict__", |
| 121 | + "__class__", |
| 122 | + "__dir__", |
| 123 | + "__weakref__", |
| 124 | + "__module__", |
| 125 | + "__annotations__", |
| 126 | + "__orig_bases__", |
| 127 | + "__parameters__", |
| 128 | + "__subclasshook__", |
| 129 | + "__init_subclass__", |
| 130 | + "__attrs_attrs__", |
| 131 | + "__init__", |
| 132 | + "__new__", |
| 133 | + "__getnewargs__", |
| 134 | + "__abstractmethods__", |
| 135 | + "__hash__", |
| 136 | + ] |
118 | 137 | autodoc_default_options = { |
119 | 138 | 'members': None, # Include all members (methods). |
120 | 139 | 'special-members': None, |
121 | 140 | "autosummary": None, |
122 | 141 | "show-inheritance": None, |
123 | | - 'exclude-members': ','.join([ # Exclude "standard" methods. |
124 | | - "__dict__", |
125 | | - "__class__", |
126 | | - "__dir__", |
127 | | - "__weakref__", |
128 | | - "__module__", |
129 | | - "__annotations__", |
130 | | - "__orig_bases__", |
131 | | - "__parameters__", |
132 | | - "__subclasshook__", |
133 | | - "__init_subclass__", |
134 | | - "__attrs_attrs__", |
135 | | - "__init__", |
136 | | - "__new__", |
137 | | - "__getnewargs__", |
138 | | - "__abstractmethods__", |
139 | | - "__hash__", |
140 | | - ]), |
| 142 | + 'exclude-members': ','.join(autodoc_exclude_members), |
141 | 143 | } |
0 commit comments