1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
"""
sphinxcontrib.apidoc
~~~~~~~~~~~~~~~~~~~~
A Sphinx extension for running 'sphinx-apidoc' on each build.
:copyright: Copyright 2018-present by Stephen Finucane <stephen@that.guru>
:license: BSD, see LICENSE for details.
"""
import pbr.version
from typing import Any
from sphinx.application import Sphinx
from sphinxcontrib.apidoc import ext
__version__ = pbr.version.VersionInfo('sphinxcontrib-apidoc').version_string()
def setup(app: Sphinx) -> dict[str, Any]:
app.setup_extension('sphinx.ext.autodoc') # We need autodoc to function
app.connect('builder-inited', ext.builder_inited)
app.add_config_value('apidoc_module_dir', None, 'env', [str])
app.add_config_value('apidoc_output_dir', 'api', 'env', [str])
app.add_config_value('apidoc_template_dir', 'templates', 'env', [str])
app.add_config_value('apidoc_excluded_paths', [], 'env', list[str])
app.add_config_value('apidoc_separate_modules', False, 'env', [bool])
app.add_config_value('apidoc_toc_file', None, 'env', [str, bool])
app.add_config_value('apidoc_module_first', False, 'env', [bool])
app.add_config_value('apidoc_extra_args', [], 'env', [list])
return {'version': __version__, 'parallel_read_safe': True}
|
