diff options
| author | Nguyen Hai <nguyentrihai93@gmail.com> | 2018-03-19 17:00:25 +0900 |
|---|---|---|
| committer | Nguyen Hai <nguyentrihai93@gmail.com> | 2018-04-19 13:15:59 +0900 |
| commit | fd7ccff5d332e5421cfefd647c3e357c67f80c23 (patch) | |
| tree | 89566d426e44777ae33e1f5520e0b4149c32d713 /doc | |
| parent | 1a9c706643f473f37abd79cd502414daa2b11903 (diff) | |
| download | python-ironicclient-fd7ccff5d332e5421cfefd647c3e357c67f80c23.tar.gz | |
Follow the new PTI for document build
- Follow new PTI for docs build
- Add sphinxcontrib.apidoc to replace pbr autodoc
REF:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html
Change-Id: I76e8ec019ef30fdc2d34a25a99e849407f586459
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 7 | ||||
| -rw-r--r-- | doc/source/api_v1.rst | 6 | ||||
| -rw-r--r-- | doc/source/conf.py | 11 |
3 files changed, 18 insertions, 6 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..4faabc1 --- /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. +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 diff --git a/doc/source/api_v1.rst b/doc/source/api_v1.rst index eb29c28..f3dea2c 100644 --- a/doc/source/api_v1.rst +++ b/doc/source/api_v1.rst @@ -96,11 +96,7 @@ Refer to the modules themselves, for more details. ironicclient Modules ==================== -.. toctree:: - :maxdepth: 1 - - modules <api/autoindex> - +* :ref:`modindex` .. _ironicclient.v1.node: api/ironicclient.v1.node.html#ironicclient.v1.node.Node .. _ironicclient.v1.client.Client: api/ironicclient.v1.client.html#ironicclient.v1.client.Client diff --git a/doc/source/conf.py b/doc/source/conf.py index 270cc79..3556454 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -2,12 +2,21 @@ # 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', +extensions = ['sphinxcontrib.apidoc', 'sphinx.ext.viewcode', 'openstackdocstheme', 'cliff.sphinxext', ] +# sphinxcontrib.apidoc options +apidoc_module_dir = '../../ironicclient' +apidoc_output_dir = 'api' +apidoc_excluded_paths = [ + 'tests/functional/*', + 'tests'] +apidoc_separate_modules = True + + # openstackdocstheme options repository_name = 'openstack/python-ironicclient' bug_project = 'python-ironicclient' |