diff options
| author | Zuul <zuul@review.openstack.org> | 2018-06-06 22:13:59 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2018-06-06 22:13:59 +0000 |
| commit | c5171adb2baae0e2dc090d6e49090e114202c787 (patch) | |
| tree | 4e7527e36a124951b6d9a5f9042db6f9274b2ee8 /doc | |
| parent | 64b5e9e8821d5fbb0eb086b4e88dc18a822b5f76 (diff) | |
| parent | a451b28c434be314c3e626fa3c4f444bb1acd979 (diff) | |
| download | keystonemiddleware-c5171adb2baae0e2dc090d6e49090e114202c787.tar.gz | |
Merge "Follow the new PTI for document build"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 1 | ||||
| -rw-r--r-- | doc/source/conf.py | 16 |
2 files changed, 13 insertions, 4 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 75c6c19..6e62d8d 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -7,6 +7,7 @@ doc8>=0.6.0 # Apache-2.0 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 +sphinxcontrib-apidoc>=0.2.0 # BSD # For autodoc builds mock>=2.0.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 0cef1f7..9e8aaff 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -10,7 +10,6 @@ # All configuration values have a default; values that are commented out # serve to show the default. -from __future__ import unicode_literals import os import sys @@ -37,14 +36,23 @@ sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), # Add any Sphinx extension module names here, as strings. They can be # extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', - 'sphinx.ext.todo', +extensions = ['sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.intersphinx', 'openstackdocstheme', - 'oslo_config.sphinxconfiggen' + 'oslo_config.sphinxconfiggen', + 'sphinxcontrib.apidoc', ] +# sphinxcontrib.apidoc options +apidoc_module_dir = '../../keystonemiddleware' +apidoc_output_dir = 'api' +apidoc_excluded_paths = [ + 'tests/*', + 'tests', + 'test'] +apidoc_separate_modules = True + config_generator_config_file = '../../config-generator/keystonemiddleware.conf' sample_config_basename = '_static/keystonemiddleware' |