From cc7b98aa1059ab7d3e929142e377379ed00e3eb8 Mon Sep 17 00:00:00 2001 From: dparalen Date: Tue, 4 Jul 2017 16:54:26 +0200 Subject: [PATCH] Introducing the contributor content Moving the contributor "link" and API down the mandatory directory structure. Change-Id: I111cd55a06e40dc4db649728a5025354a85b3e1d Partial-Bug: 1702142 --- .gitignore | 5 ++--- CONTRIBUTING.rst | 2 +- doc/source/contributing.rst | 3 --- doc/source/contributor/index.rst | 11 +++++++++++ doc/source/index.rst | 16 ++++------------ setup.cfg | 1 + 6 files changed, 19 insertions(+), 19 deletions(-) delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/index.rst diff --git a/.gitignore b/.gitignore index 21efccf71..82f0112dd 100644 --- a/.gitignore +++ b/.gitignore @@ -6,7 +6,7 @@ # Sphinx _build -#doc/source/api/ +doc/source/contributor/api/ # release notes build releasenotes/build @@ -39,5 +39,4 @@ ChangeLog *~ # Vagrant -.vagrant -doc/source/api/ +.vagrant \ No newline at end of file diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 94d13147d..c69f8cc90 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -107,7 +107,7 @@ enable both the **ironic** and the **ironic-inspector**. You can start with the Example local.conf ------------------ -.. literalinclude:: ../../devstack/example.local.conf +.. literalinclude:: ../../../devstack/example.local.conf Notes diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index e9e65340a..000000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. _contributing_link: - -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 000000000..ac9f2210b --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,11 @@ +.. _contributing_link: + +.. include:: ../../../CONTRIBUTING.rst + +Python API +~~~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + + api/autoindex diff --git a/doc/source/index.rst b/doc/source/index.rst index d2392152a..e03c3350d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -20,21 +20,13 @@ Admin Guide Installation Upgrade -Developer Guide -=============== +Contributor +=========== .. toctree:: - :maxdepth: 2 + :maxdepth: 2 - Contributing - -Python API ----------- - -.. toctree:: - :maxdepth: 1 - - api/autoindex + contributor/index Indices and tables ================== diff --git a/setup.cfg b/setup.cfg index 2e85ee1b0..c6d9735e1 100644 --- a/setup.cfg +++ b/setup.cfg @@ -98,3 +98,4 @@ autodoc_exclude_modules = ironic_inspector.migrations.* ironic_inspector.test.* ironic.common.i18n +api_doc_dir = contributor/api