rearrange content to fit the new standard layout

Change-Id: Idaa0dde5e4fd14213ae1611560897a27e9f72514 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
2017-07-01 01:07:04 +08:00 · 2017-07-01 01:07:04 +08:00 · fe64db1d45
commit fe64db1d45
parent d17be6e20c
12 changed files with 35 additions and 16 deletions
--- a/.gitignore
+++ b/.gitignore
@ -18,4 +18,4 @@ ChangeLog
 .project
 .pydevproject
 oslo.db.egg-info/
-doc/source/api
+doc/source/reference/api
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@ -1 +0,0 @@
-.. include:: ../../CONTRIBUTING.rst
--- a/doc/source/contributor/index.rst
+++ b/doc/source/contributor/index.rst
@ -0,0 +1 @@
+.. include:: ../../../CONTRIBUTING.rst
--- a/doc/source/history.rst
+++ b/doc/source/history.rst
@ -1 +0,0 @@
-.. include:: ../../ChangeLog
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@ -9,19 +9,10 @@ utils.
 .. toctree::
   :maxdepth: 2

-   installation
-   opts
-   usage
-   contributing
-   history
-
-API Documentation
-=================
-
-.. toctree::
-   :maxdepth: 1
-
-   api/autoindex
+   install/index
+   contributor/index
+   user/index
+   reference/index

 Indices and tables
 ==================
--- a/doc/source/install/index.rst
+++ b/doc/source/install/index.rst
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@ -0,0 +1,18 @@
+.. _using:
+
+=========
+Reference
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   opts
+
+API
+===
+
+.. toctree::
+   :maxdepth: 1
+
+   api/autoindex
--- a/doc/source/reference/opts.rst
+++ b/doc/source/reference/opts.rst
--- a/doc/source/user/history.rst
+++ b/doc/source/user/history.rst
@ -0,0 +1 @@
+.. include:: ../../../ChangeLog
--- a/doc/source/user/index.rst
+++ b/doc/source/user/index.rst
@ -0,0 +1,9 @@
+==============
+ Using oslo.db
+==============
+
+.. toctree::
+   :maxdepth: 2
+
+   usage
+   history
--- a/doc/source/user/usage.rst
+++ b/doc/source/user/usage.rst
--- a/setup.cfg
+++ b/setup.cfg
@ -92,5 +92,6 @@ output_file = oslo_db/locale/oslo_db.pot
 [pbr]
 warnerrors = True
 autodoc_index_modules = True
+api_doc_dir = reference/api
 autodoc_exclude_modules =
   oslo_db.tests.*