diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2018-04-03 17:29:59 +0100 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2018-07-10 17:15:26 +0100 |
| commit | 63d741fd6646b360818c07a9679344e889031949 (patch) | |
| tree | 0c73ca5a0ab47e8409b67ab8b3f75d60c2812018 /doc | |
| parent | d6cf027be1125f5b1564b317bf13852bc5015230 (diff) | |
| download | python-openstackclient-63d741fd6646b360818c07a9679344e889031949.tar.gz | |
Replace pbr autodoc with sphinxcontrib-apidoc
This fixes local building of the documentation using tox, and allows the
gate to stop relying on pbr and move completely to the new docs PTI.
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html
Change-Id: I485acda07098a435753e91c1ca45e586de199c35
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 3 | ||||
| -rw-r--r-- | doc/source/conf.py | 19 |
2 files changed, 13 insertions, 9 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index d959d443..1afc73d6 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,4 +3,5 @@ # process, which may cause wedges in the gate later. openstackdocstheme>=1.18.1 # Apache-2.0 reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD +sphinxcontrib-apidoc>=0.2.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index d7efbd7b..003bfcaa 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -12,16 +12,8 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import os -import sys - import pbr.version -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))) - # -- General configuration ---------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. @@ -35,6 +27,7 @@ extensions = ['sphinx.ext.autodoc', 'openstackdocstheme', 'stevedore.sphinxext', 'cliff.sphinxext', + 'sphinxcontrib.apidoc', ] # openstackdocstheme options @@ -282,3 +275,13 @@ autoprogram_cliff_application = 'openstack' autoprogram_cliff_ignored = [ '--help', '--format', '--column', '--max-width', '--fit-width', '--print-empty', '--prefix', '--noindent', '--quote'] + + +# -- Options for sphinxcontrib.apidoc ---------------------------------------- + +apidoc_module_dir = '../../openstackclient' +apidoc_excluded_paths = [ + 'volume/v3', + 'tests', +] +apidoc_output_dir = 'contributor/api' |