diff options
| author | Zuul <zuul@review.openstack.org> | 2018-07-11 16:02:39 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2018-07-11 16:02:39 +0000 |
| commit | 84755a81b517a766040e19aefc2be0ff786ab53b (patch) | |
| tree | f9b19c4175b77c1701ed3932dafea7e71d183bdd /doc | |
| parent | 70031687f9252bd077c3cfa2c1541a9d8536bd90 (diff) | |
| parent | 63d741fd6646b360818c07a9679344e889031949 (diff) | |
| download | python-openstackclient-84755a81b517a766040e19aefc2be0ff786ab53b.tar.gz | |
Merge "Replace pbr autodoc with sphinxcontrib-apidoc"
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' |
