|
10 | 10 | sys.path.append(os.path.abspath('.'))
|
11 | 11 | sys.path.append(os.path.abspath('..'))
|
12 | 12 |
|
| 13 | +# this package |
13 | 14 | from __pkginfo__ import __version__
|
14 | 15 |
|
15 |
| -# User-configurable lines |
16 |
| -# End of user-configurable lines |
17 |
| - |
18 | 16 | github_username = "domdfcoding"
|
19 | 17 | github_repository = "flake8_strftime"
|
20 | 18 | github_url = f"https://github.com/{github_username}/{github_repository}"
|
21 | 19 |
|
22 |
| - |
23 | 20 | rst_prolog = f""".. |pkgname| replace:: flake8_strftime
|
24 | 21 | .. |pkgname2| replace:: ``flake8_strftime``
|
25 | 22 | .. |browse_github| replace:: `Browse the GitHub Repository <{github_url}>`__
|
|
34 | 31 | package_root = "flake8_strftime"
|
35 | 32 |
|
36 | 33 | extensions = [
|
37 |
| - 'sphinx_toolbox', |
38 |
| - 'sphinx_toolbox.more_autodoc', |
39 |
| - 'sphinx_toolbox.more_autosummary', |
40 |
| - 'sphinx_toolbox.tweaks.param_dash', |
41 |
| - 'sphinx.ext.intersphinx', |
42 |
| - 'sphinx.ext.mathjax', |
43 |
| - 'sphinxcontrib.httpdomain', |
44 |
| - 'sphinxcontrib.extras_require', |
45 |
| - 'sphinx.ext.todo', |
46 |
| - 'sphinxemoji.sphinxemoji', |
47 |
| - 'notfound.extension', |
48 |
| - 'sphinx_copybutton', |
49 |
| - 'sphinxcontrib.default_values', |
50 |
| - 'sphinxcontrib.toctree_plus', |
51 |
| - 'seed_intersphinx_mapping', |
52 |
| - ] |
| 34 | + 'sphinx_toolbox', |
| 35 | + 'sphinx_toolbox.more_autodoc', |
| 36 | + 'sphinx_toolbox.more_autosummary', |
| 37 | + 'sphinx_toolbox.tweaks.param_dash', |
| 38 | + 'sphinx.ext.intersphinx', |
| 39 | + 'sphinx.ext.mathjax', |
| 40 | + 'sphinxcontrib.httpdomain', |
| 41 | + 'sphinxcontrib.extras_require', |
| 42 | + 'sphinx.ext.todo', |
| 43 | + 'sphinxemoji.sphinxemoji', |
| 44 | + 'notfound.extension', |
| 45 | + 'sphinx_copybutton', |
| 46 | + 'sphinxcontrib.default_values', |
| 47 | + 'sphinxcontrib.toctree_plus', |
| 48 | + 'seed_intersphinx_mapping', |
| 49 | + ] |
53 | 50 |
|
54 | 51 | sphinxemoji_style = 'twemoji'
|
55 | 52 | todo_include_todos = bool(os.environ.get("SHOW_TODOS", 0))
|
|
67 | 64 | intersphinx_mapping = {
|
68 | 65 | 'python': ('https://docs.python.org/3/', None),
|
69 | 66 | 'sphinx': ('https://www.sphinx-doc.org/en/stable/', None),
|
70 |
| - 'rtd': ('https://docs.readthedocs.io/en/latest/', None), |
71 |
| - "h5py": ('https://docs.h5py.org/en/latest/', None), |
72 |
| - "sarge": ('https://sarge.readthedocs.io/en/latest/', None), |
73 | 67 | }
|
74 | 68 |
|
75 | 69 | html_theme = 'domdf_sphinx_theme'
|
|
110 | 104 | }
|
111 | 105 |
|
112 | 106 | add_module_names = False
|
113 |
| - |
114 |
| - |
| 107 | +hide_none_rtype = True |
| 108 | +all_typevars = True |
| 109 | +overloads_location = "bottom" |
| 110 | + |
| 111 | + |
| 112 | +autodoc_exclude_members = [ # Exclude "standard" methods. |
| 113 | + "__dict__", |
| 114 | + "__class__", |
| 115 | + "__dir__", |
| 116 | + "__weakref__", |
| 117 | + "__module__", |
| 118 | + "__annotations__", |
| 119 | + "__orig_bases__", |
| 120 | + "__parameters__", |
| 121 | + "__subclasshook__", |
| 122 | + "__init_subclass__", |
| 123 | + "__attrs_attrs__", |
| 124 | + "__init__", |
| 125 | + "__new__", |
| 126 | + "__getnewargs__", |
| 127 | + "__abstractmethods__", |
| 128 | + "__hash__", |
| 129 | + ] |
115 | 130 | autodoc_default_options = {
|
116 | 131 | 'members': None, # Include all members (methods).
|
117 | 132 | 'special-members': None,
|
118 | 133 | "autosummary": None,
|
119 | 134 | "show-inheritance": None,
|
120 |
| - 'exclude-members': ','.join([ # Exclude "standard" methods. |
121 |
| - "__dict__", |
122 |
| - "__class__", |
123 |
| - "__dir__", |
124 |
| - "__weakref__", |
125 |
| - "__module__", |
126 |
| - "__annotations__", |
127 |
| - "__orig_bases__", |
128 |
| - "__parameters__", |
129 |
| - "__subclasshook__", |
130 |
| - "__init_subclass__", |
131 |
| - "__attrs_attrs__", |
132 |
| - "__init__", |
133 |
| - "__new__", |
134 |
| - "__getnewargs__", |
135 |
| - "__abstractmethods__", |
136 |
| - "__hash__", |
137 |
| - ]), |
| 135 | + 'exclude-members': ','.join(autodoc_exclude_members), |
138 | 136 | }
|
0 commit comments