diff options
| author | Akihiro Motoki <amotoki@gmail.com> | 2017-07-06 21:18:00 +0000 |
|---|---|---|
| committer | Akihiro Motoki <amotoki@gmail.com> | 2017-07-11 14:11:12 +0000 |
| commit | a1598502bd65576e9e23959a0cf412add5de23b8 (patch) | |
| tree | d0ad1b96c93e100a2c8ae3408336f52cfea5b819 | |
| parent | 01443b83803ff6348033ccaf5cc737047c02162b (diff) | |
| download | oslo-vmware-a1598502bd65576e9e23959a0cf412add5de23b8.tar.gz | |
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
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | doc/source/contributing.rst | 1 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/history.rst | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 27 | ||||
| -rw-r--r-- | doc/source/install/index.rst (renamed from doc/source/installation.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 9 | ||||
| -rw-r--r-- | doc/source/user/history.rst | 1 | ||||
| -rw-r--r-- | doc/source/user/index.rst | 9 | ||||
| -rw-r--r-- | doc/source/user/usage.rst (renamed from doc/source/usage.rst) | 0 | ||||
| -rw-r--r-- | setup.cfg | 1 |
11 files changed, 27 insertions, 25 deletions
@@ -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 8cb3146..0000000 --- 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 0000000..b1cd2f3 --- /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 69ed4fe..0000000 --- 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 41ea896..b5e6d74 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 index e7a6f4d..e7a6f4d 100644 --- a/doc/source/installation.rst +++ b/doc/source/install/index.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 0000000..be6c6b7 --- /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 0000000..f69be70 --- /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 0000000..b314802 --- /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 index 9561ffc..9561ffc 100644 --- a/doc/source/usage.rst +++ b/doc/source/user/usage.rst @@ -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 |