openstack/python-ironicclient
Code Issues Proposed changes

Include python API reference in docs

Browse Source 
Also move the autogenerated docs to the reference folder.

Change-Id: I3e5a34c8a486bf022a940967fec9d5fc939c4489
This commit is contained in:
Vladyslav Drok 2018-05-31 11:39:20 +03:00
parent 69f1bb8c01
commit 3f730d3009
3 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/conf.py
View File

@ -10,7 +10,7 @@ extensions = ['sphinxcontrib.apidoc',
# sphinxcontrib.apidoc options # sphinxcontrib.apidoc options
apidoc_module_dir = '../../ironicclient' apidoc_module_dir = '../../ironicclient'
apidoc_output_dir = 'api' apidoc_output_dir = 'reference/api'
apidoc_excluded_paths = [ apidoc_excluded_paths = [
'tests/functional/*', 'tests/functional/*',
'tests'] 'tests']

1
doc/source/index.rst
View File

@ -18,6 +18,7 @@ Contents
cli/index cli/index
user/create_command user/create_command
contributor/index contributor/index
reference/index
Release Notes <https://docs.openstack.org/releasenotes/python-ironicclient/> Release Notes <https://docs.openstack.org/releasenotes/python-ironicclient/>
Indices and tables Indices and tables

8
doc/source/reference/index.rst Normal file
View File

@ -0,0 +1,8 @@
=======================================
Full Ironic Client Python API Reference
=======================================
.. toctree::
:maxdepth: 1
api/modules