rearrange content to fit the new standard layout

Change-Id: Iaa7583223650ff4bd0e91995c21497c62a84f334

.gitignore

@@ -6,7 +6,7 @@ cover/
 covhtml/
 dist/
 doc/build
-doc/source/api/
+doc/source/contributor/api/
 etc/*.sample
 *.DS_Store
 *.pyc

devstack/README.rst

@@ -1,3 +1,4 @@
+=========================
 neutron-fwaas in DevStack
 =========================
 

doc/source/contributor/contributing.rst

@@ -1,26 +1,22 @@
+=============================
 Contributing to neutron-fwaas
 =============================
 
 If you would like to contribute to the development of OpenStack, you must
 follow the steps documented at:
-
-    https://docs.openstack.org/infra/manual/developers.html
+https://docs.openstack.org/infra/manual/developers.html
 
 Once those steps have been completed, changes to OpenStack should be submitted
 for review via the Gerrit tool, following the workflow documented at:
-
-    https://docs.openstack.org/infra/manual/developers.html#development-workflow
+https://docs.openstack.org/infra/manual/developers.html#development-workflow
 
 Pull requests submitted through GitHub will be ignored.
 
 Bugs should be filed on Launchpad in the 'neutron' project:
+https://bugs.launchpad.net/neutron
 
-    https://bugs.launchpad.net/neutron
-
-Getting in touch with the neutron-fwaas community
-=================================================
-
-To contribute to the neutron-fwaas project, look at the following resources:
+To get in touch with the neutron-fwaas community,
+look at the following resources:
 
 - Join the #openstack-fwaas IRC channel on Freenode.  This is where the
   FireWall-as-a-Service team is available for discussion.
@@ -30,4 +26,3 @@ To contribute to the neutron-fwaas project, look at the following resources:
 
 These are a great places to get recommendations on where to start contributing
 to neutron-fwaas.
-

doc/source/contributor/devstack.rst

@@ -0,0 +1 @@
+.. include:: ../../../devstack/README.rst

doc/source/contributor/index.rst

@@ -0,0 +1,17 @@
+=================
+Contributor Guide
+=================
+
+.. toctree::
+   :maxdepth: 2
+
+   contributing
+   fwaas_v2
+   devstack
+
+.. API reference contains a lot of sections, toctree with maxdepth 1 is used.
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   modules

doc/source/contributor/modules.rst

@@ -0,0 +1,9 @@
+================
+Module Reference
+================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   api/*

doc/source/devstack.rst

@@ -1 +0,0 @@
-.. include:: ../../devstack/README.rst

doc/source/index.rst

@@ -1,27 +1,15 @@
-.. documentation master file
-
-
-Developer documentation for neutron-fwaas
-=========================================
+===========================
+neutron-fwaas documentation
+===========================
 
 General Information and Other Project References:
 
 .. toctree::
    :glob:
-   :maxdepth: 1
+   :maxdepth: 2
 
-   installation
-   fwaas_v2
-   contributing
-
-Testing and Usage Information:
-
-.. toctree::
-   :glob:
-   :maxdepth: 1
-
-   devstack
-   API reference <api/modules>
+   install/index
+   contributor/index
 
 .. rubric:: Indices and tables
 

setup.cfg

@@ -83,3 +83,4 @@ autodoc_tree_index_modules = True
 autodoc_tree_excludes =
   setup.py
   neutron_fwaas/tests
+api_doc_dir = contributor/api