Merge "Doc Migration: move the developer guide docs under contributor folder"

README.rst

@@ -4,7 +4,6 @@ Team and repository tags
 
 .. image:: https://governance.openstack.org/badges/python-vitrageclient.svg
     :target: https://governance.openstack.org/reference/tags/index.html
-    :remote:
 
 .. Change things from this point on
 
@@ -46,9 +45,16 @@ Manual Install Steps:
 Building and Packaging
 ----------------------
 Install the tool dependencies
+
+::
+
     sudo apt-get install python-pip python-virtualenv
 
+
 In the python-vitrageclient source directory
+
+::
+
     virtualenv --no-site-packages .venv
 
     source ./.venv/bin/activate

doc/source/contributor/contributing.rst

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

doc/source/contributor/index.rst

@@ -0,0 +1,5 @@
+Developer's Reference
+=====================
+
+.. toctree::
+   :maxdepth: 1

doc/source/contributor/readme.rst

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

doc/source/index.rst

@@ -6,21 +6,28 @@
 Welcome to python-vitrageclient's documentation!
 ================================================
 
-Contents:
+Developer Guide
+---------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   readme
+   contributor/readme
-   installation
+   contributor/installation
-   usage
+   contributor/usage
-   contributing
+   contributor/contributing
-   cli
+   contributor/cli
+
+.. # NOTE(ifat-afek): Hide files we don't want to see in the table of contents.
+   # sphinx build fails if a file is not included in the toctree.
+.. toctree::
+   :hidden:
+
+   contributor/index
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

doc/source/readme.rst

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

setup.cfg

@@ -54,6 +54,7 @@ openstack.rca.v1 =
 source-dir = doc/source
 build-dir = doc/build
 all_files = 1
+warning-is-error = 1
 
 [upload_sphinx]
 upload-dir = doc/build/html