diff options
| author | Julia Kreger <juliaashleykreger@gmail.com> | 2020-06-09 15:08:10 -0700 |
|---|---|---|
| committer | Julia Kreger <juliaashleykreger@gmail.com> | 2020-06-15 11:30:02 -0700 |
| commit | cf870ae5108d7e0f03bcb2d4c41515b919bc51a6 (patch) | |
| tree | 44feea3455015dca9e9bde06d0dbed9de5a5aea8 /doc/source | |
| parent | 504c52389b3074e3eecfe34c486f60ea1b3d39d7 (diff) | |
| download | ironic-python-agent-cf870ae5108d7e0f03bcb2d4c41515b919bc51a6.tar.gz | |
Fix apidoc build
Change-Id: Id7c5686cdbdc79812e06eb4a5f87eddc75005cc3
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/conf.py | 9 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 2 |
2 files changed, 10 insertions, 1 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 15feefce..f64921bb 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -4,6 +4,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', + 'sphinxcontrib.apidoc', 'openstackdocstheme', ] @@ -36,6 +37,14 @@ add_module_names = True # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'native' +# sphinxcontrib.apidoc options +apidoc_module_dir = '../../ironic_python_agent' +apidoc_output_dir = 'contributor/api' +apidoc_excluded_paths = [ + 'tests', +] +apidoc_separate_modules = True + # -- Options for HTML output -------------------------------------------------- diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 4f421637..bba5cbb3 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -29,7 +29,7 @@ Generated Developer Documentation .. toctree:: :hidden: - api/autoindex + api/modules Indices and tables ================== |