rearrange content to fit the new standard layout

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454

Change-Id: Ic8d93ffc98b347e4158c715b88d15372b0948887

.gitignore

@@ -47,7 +47,7 @@ doc/build
 # pbr generates these
 AUTHORS
 ChangeLog
-/doc/source/api/
+doc/source/reference/api
 
 # Editors
 *~

doc/source/contributor/index.rst

@@ -2,4 +2,4 @@
  Contributing
 ==============
 
-.. include:: ../../CONTRIBUTING.rst
+.. include:: ../../../CONTRIBUTING.rst

doc/source/history.rst

@@ -1 +0,0 @@
-.. include:: ../../ChangeLog

doc/source/index.rst

@@ -10,26 +10,10 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   installation
-   usage
-   opts
-   contributing
-
-API
-===
-
-.. toctree::
-   :maxdepth: 2
-
-   api/autoindex
-
-Release Notes
-=============
-
-.. toctree::
-   :maxdepth: 1
-
-   history
+   install/index
+   contributor/index
+   user/index
+   reference/index
 
 Indices and tables
 ==================

doc/source/install/index.rst

@@ -1,6 +1,6 @@
-==============
- Installation
-==============
+============
+Installation
+============
 
 At the command line::
 

doc/source/reference/index.rst

@@ -0,0 +1,18 @@
+.. _using:
+
+=========
+Reference
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   opts
+
+API
+===
+
+.. toctree::
+   :maxdepth: 1
+
+   api/autoindex

doc/source/reference/opts.rst

@@ -1,6 +1,8 @@
-=======================
- Configuration Options
-=======================
+.. _option-definitions:
+
+=====================
+Configuration Options
+=====================
 
 oslo.reports uses oslo.config to define and manage configuration options
 to allow the deployer to control where the GMR reports should be generated.

doc/source/user/history.rst

@@ -0,0 +1 @@
+.. include:: ../../../ChangeLog

doc/source/user/index.rst

@@ -0,0 +1,9 @@
+===================
+ Using oslo.reports
+===================
+
+.. toctree::
+   :maxdepth: 2
+
+   usage
+   history

doc/source/user/report.txt

@@ -752,4 +752,4 @@ workarounds:
   destroy_after_evacuate = True
   disable_libvirt_livesnapshot = True
   disable_rootwrap = False
-  handle_virt_lifecycle_events = True
+  handle_virt_lifecycle_events = True

setup.cfg

@@ -24,6 +24,7 @@ packages =
 
 [pbr]
 autodoc_index_modules = true
+api_doc_dir = reference/api
 autodoc_exclude_modules =
     oslo_reports._i18n
     oslo_reports._utils