From 3f730d3009c7ebf854efaccc7dfee6c374dca896 Mon Sep 17 00:00:00 2001 From: Vladyslav Drok Date: Thu, 31 May 2018 11:39:20 +0300 Subject: [PATCH] Include python API reference in docs Also move the autogenerated docs to the reference folder. Change-Id: I3e5a34c8a486bf022a940967fec9d5fc939c4489 --- doc/source/conf.py | 2 +- doc/source/index.rst | 1 + doc/source/reference/index.rst | 8 ++++++++ 3 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 doc/source/reference/index.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 355645454..61e9a99a3 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 86473136a..cc14818ea 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 Indices and tables diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 000000000..87dea8a7c --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,8 @@ +======================================= +Full Ironic Client Python API Reference +======================================= + +.. toctree:: + :maxdepth: 1 + + api/modules