From a1598502bd65576e9e23959a0cf412add5de23b8 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Thu, 6 Jul 2017 21:18:00 +0000 Subject: [PATCH] rearrange existing documentation to fit the new standard layout For more detail, see the doc migration spec: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html There is also the recent status of the work posted in the dev ML: http://lists.openstack.org/pipermail/openstack-dev/2017-July/119221.html Change-Id: I1e728fc0bc671150d826747010eb980176f0cc13 --- .gitignore | 2 +- doc/source/contributing.rst | 1 - doc/source/contributor/index.rst | 1 + doc/source/history.rst | 1 - doc/source/index.rst | 27 ++++--------------- .../{installation.rst => install/index.rst} | 0 doc/source/reference/index.rst | 9 +++++++ doc/source/user/history.rst | 1 + doc/source/user/index.rst | 9 +++++++ doc/source/{ => user}/usage.rst | 0 setup.cfg | 1 + 11 files changed, 27 insertions(+), 25 deletions(-) delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/index.rst delete mode 100644 doc/source/history.rst rename doc/source/{installation.rst => install/index.rst} (100%) create mode 100644 doc/source/reference/index.rst create mode 100644 doc/source/user/history.rst create mode 100644 doc/source/user/index.rst rename doc/source/{ => user}/usage.rst (100%) diff --git a/.gitignore b/.gitignore index ad7778b3..7f191f8a 100644 --- a/.gitignore +++ b/.gitignore @@ -50,7 +50,7 @@ ChangeLog # Editors *~ .*.swp -/doc/source/api/ +/doc/source/reference/api/ # reno build releasenotes/build diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 8cb3146f..00000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../CONTRIBUTING.rst \ No newline at end of file diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 00000000..b1cd2f37 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1 @@ +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe6..00000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index 41ea8967..b5e6d747 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,29 +8,12 @@ and APIs. .. toctree:: :maxdepth: 2 - installation - usage - contributing + install/index + user/index + contributor/index + reference/index -Code Documentation -================== - -.. toctree:: - :maxdepth: 1 - - api/autoindex - -Release Notes -============= - -.. toctree:: - :maxdepth: 1 - - history - - -Indices and tables -================== +.. rubric:: Indices and tables * :ref:`genindex` * :ref:`modindex` diff --git a/doc/source/installation.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 00000000..be6c6b71 --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,9 @@ +============= +API Reference +============= + +.. toctree:: + :maxdepth: 1 + :glob: + + api/* diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 00000000..f69be70b --- /dev/null +++ b/doc/source/user/history.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 00000000..b3148024 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,9 @@ +================= +Using oslo.vmware +================= + +.. toctree:: + :maxdepth: 1 + + usage + history diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/usage.rst diff --git a/setup.cfg b/setup.cfg index f7338b51..b07d2adc 100644 --- a/setup.cfg +++ b/setup.cfg @@ -50,6 +50,7 @@ autodoc_index_modules = 1 autodoc_exclude_modules = oslo_vmware._i18n oslo_vmware.tests.* +api_doc_dir = reference/api [wheel] universal = 1