diff options
| author | Vladyslav Drok <vdrok@mirantis.com> | 2018-05-31 11:39:20 +0300 |
|---|---|---|
| committer | Vladyslav Drok <vdrok@mirantis.com> | 2018-05-31 12:34:35 +0300 |
| commit | 3f730d3009c7ebf854efaccc7dfee6c374dca896 (patch) | |
| tree | 3f0c108f50f67a711520d50e0e9dc26b6dcc6b7c /doc/source | |
| parent | 69f1bb8c01095432c740ce21c8a8228ad49511a8 (diff) | |
| download | python-ironicclient-3f730d3009c7ebf854efaccc7dfee6c374dca896.tar.gz | |
Include python API reference in docs
Also move the autogenerated docs to the reference folder.
Change-Id: I3e5a34c8a486bf022a940967fec9d5fc939c4489
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/conf.py | 2 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 8 |
3 files changed, 10 insertions, 1 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 3556454..61e9a99 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -10,7 +10,7 @@ extensions = ['sphinxcontrib.apidoc', # sphinxcontrib.apidoc options apidoc_module_dir = '../../ironicclient' -apidoc_output_dir = 'api' +apidoc_output_dir = 'reference/api' apidoc_excluded_paths = [ 'tests/functional/*', 'tests'] diff --git a/doc/source/index.rst b/doc/source/index.rst index 8647313..cc14818 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -18,6 +18,7 @@ Contents cli/index user/create_command contributor/index + reference/index Release Notes <https://docs.openstack.org/releasenotes/python-ironicclient/> Indices and tables diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 0000000..87dea8a --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,8 @@ +======================================= +Full Ironic Client Python API Reference +======================================= + +.. toctree:: + :maxdepth: 1 + + api/modules |