doc: Rearrange documentation layout

Following the doc spec. [1]

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Closes-Bug: #1701204
Change-Id: Ie6e58a6379b51bf53f8f12c1372599cde1164d78

devstack/README.rst

@@ -19,7 +19,7 @@ You can find an example at `devstack/ml2/local.conf.sample
 <https://git.openstack.org/cgit/openstack/networking-midonet/plain/devstack/ml2/local.conf.sample>`_
 in the source tree.
 
-.. literalinclude:: ../../devstack/ml2/local.conf.sample
+.. literalinclude:: ../../../devstack/ml2/local.conf.sample
 
 MidoNet plugin (deprecated)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -28,7 +28,7 @@ You can find an example at `devstack/midonet/local.conf.sample
 <https://git.openstack.org/cgit/openstack/networking-midonet/plain/devstack/midonet/local.conf.sample>`_
 in the source tree.
 
-.. literalinclude:: ../../devstack/midonet/local.conf.sample
+.. literalinclude:: ../../../devstack/midonet/local.conf.sample
 
 
 MidoNet backend communication

doc/source/contributor/devstack.rst

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

doc/source/contributor/index.rst

@@ -0,0 +1,43 @@
+Contributor Guide
+=================
+
+
+DevStack plugin
+---------------
+.. toctree::
+   :maxdepth: 2
+
+   devstack
+
+
+Policies
+--------
+.. toctree::
+   :maxdepth: 2
+
+   policies
+
+
+Programming HowTos and Tutorials
+--------------------------------
+.. toctree::
+   :maxdepth: 2
+
+   alembic_migrations
+   testing
+
+
+Networking MidoNet Internals
+----------------------------
+.. toctree::
+   :maxdepth: 2
+
+   firewall
+
+
+Dashboards
+----------
+.. toctree::
+   :maxdepth: 2
+
+   dashboards

doc/source/devref/index.rst

@@ -1,64 +0,0 @@
-..
-      Copyright (C) 2015 Midokura SARL.
-      All Rights Reserved.
-
-      Licensed under the Apache License, Version 2.0 (the "License"); you may
-      not use this file except in compliance with the License. You may obtain
-      a copy of the License at
-
-          http://www.apache.org/licenses/LICENSE-2.0
-
-      Unless required by applicable law or agreed to in writing, software
-      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-      License for the specific language governing permissions and limitations
-      under the License.
-
-      Convention for heading levels in Networking MidoNet devref:
-      =======  Heading 0 (reserved for the title in a document)
-      -------  Heading 1
-      ~~~~~~~  Heading 2
-      +++++++  Heading 3
-      '''''''  Heading 4
-      (Avoid deeper levels because they do not render well.)
-
-
-Developer Guide
-===============
-
-In the Developer Guide, you will find information on Networking MidoNet's lower
-level designs.
-The developer guide also includes information about testing infrastructure.
-
-
-Policies
---------
-.. toctree::
-   :maxdepth: 3
-
-   policies
-
-
-Programming HowTos and Tutorials
---------------------------------
-.. toctree::
-   :maxdepth: 3
-
-   alembic_migrations
-   testing
-
-
-Networking MidoNet Internals
-----------------------------
-.. toctree::
-   :maxdepth: 3
-
-   firewall
-
-
-Indices and tables
-------------------
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

doc/source/devstack.rst

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

doc/source/index.rst

@@ -4,24 +4,38 @@
    contain the root `toctree` directive.
 
 Welcome to networking-midonet's documentation!
-========================================================
+==============================================
 
-Contents:
+Networking-midonet is a set of Neutron plugins and drivers for MidoNet.
 
+
+Installation
+------------
 .. toctree::
    :maxdepth: 2
 
-   installation
-   devstack
-   history
-   upgrade
-   ml2_migration
-   devref/index
-   specs/index
-   dashboards/index
+   install/installation
+   install/history
+   install/upgrade
+   install/ml2_migration
+
+Contributor Guide
+-----------------
+.. toctree::
+   :maxdepth: 2
+
+   contributor/index
+
+References
+----------
+.. toctree::
+   :maxdepth: 2
+
+   reference/specs/index
+
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`

doc/source/install/index.rst

@@ -0,0 +1,11 @@
+:orphan:
+
+Installation
+============
+.. toctree::
+   :maxdepth: 2
+
+   installation
+   history
+   upgrade
+   ml2_migration

doc/source/reference/index.rst

@@ -0,0 +1,11 @@
+:orphan:
+
+References
+==========
+
+Specifications
+--------------
+.. toctree::
+   :maxdepth: 2
+
+   specs/index

doc/source/reference/specs

@@ -0,0 +1 @@
+../../../specs

doc/source/specs

@@ -1 +0,0 @@
-../../specs