diff options
| author | Nguyen Hai <nguyentrihai93@gmail.com> | 2018-07-07 11:07:38 +0900 |
|---|---|---|
| committer | Nguyen Hai <nguyentrihai93@gmail.com> | 2018-07-16 01:26:52 +0000 |
| commit | b65459e69defe5fb6b0388df0a74a90249ca053e (patch) | |
| tree | 694a744c2af057b2185e53f902480506234be458 /doc | |
| parent | 0c3a15618b9e629dbdecb51cfde686637d08fd55 (diff) | |
| download | glance_store-b65459e69defe5fb6b0388df0a74a90249ca053e.tar.gz | |
Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
[3] http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html
Change-Id: I06d510a44b9e8c0024f5e41f10f4446e18bf86cc
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 7 | ||||
| -rw-r--r-- | doc/source/conf.py | 11 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 2 |
3 files changed, 18 insertions, 2 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..67530ff --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,7 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +openstackdocstheme>=1.18.1 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 +sphinxcontrib-apidoc>=0.2.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 64ff8e6..3ff6345 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,8 @@ sys.path.insert(0, os.path.abspath('../..')) # 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', 'openstackdocstheme'] +extensions = ['openstackdocstheme', + 'sphinxcontrib.apidoc'] # openstackdocstheme options repository_name = 'openstack/glance_store' @@ -31,6 +32,14 @@ bug_project = 'glance-store' bug_tag = '' html_last_updated_fmt = '%Y-%m-%d %H:%M' +# sphinxcontrib.apidoc options +apidoc_module_dir = '../../glance_store' +apidoc_output_dir = 'reference/api' +apidoc_excluded_paths = [ + 'test', + 'tests/*'] +apidoc_separate_modules = True + # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index c654ff7..ca24b39 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -5,4 +5,4 @@ .. toctree:: :maxdepth: 1 - api/autoindex + api/modules |