diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 5 | ||||
| -rw-r--r-- | doc/source/conf.py | 9 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 2 |
3 files changed, 15 insertions, 1 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..64d6a305 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,5 @@ +doc8>=0.6.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 +sphinxcontrib-apidoc>=0.2.0 # BSD 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 ================== |