From 9b94b76af7928dfa88a34259d09e0ef489eb0409 Mon Sep 17 00:00:00 2001
From: Ifat Afek <ifat.afek@nokia.com>
Date: Tue, 25 Jul 2017 10:59:18 +0000
Subject: [PATCH] Doc Migration: move the developer guide docs under
 contributor folder

Change-Id: I96db1d8cadb17d259c708967a4e92160e9ac3aba
---
 README.rst                                    |  8 +++++-
 doc/source/contributor/.gitkeep               |  0
 doc/source/{ => contributor}/cli.rst          |  0
 doc/source/{ => contributor}/contributing.rst |  2 +-
 doc/source/contributor/index.rst              |  5 ++++
 doc/source/{ => contributor}/installation.rst |  0
 doc/source/contributor/readme.rst             |  1 +
 doc/source/{ => contributor}/usage.rst        |  0
 doc/source/index.rst                          | 25 ++++++++++++-------
 doc/source/readme.rst                         |  1 -
 setup.cfg                                     |  1 +
 11 files changed, 31 insertions(+), 12 deletions(-)
 delete mode 100644 doc/source/contributor/.gitkeep
 rename doc/source/{ => contributor}/cli.rst (100%)
 rename doc/source/{ => contributor}/contributing.rst (50%)
 create mode 100644 doc/source/contributor/index.rst
 rename doc/source/{ => contributor}/installation.rst (100%)
 create mode 100644 doc/source/contributor/readme.rst
 rename doc/source/{ => contributor}/usage.rst (100%)
 delete mode 100644 doc/source/readme.rst

diff --git a/README.rst b/README.rst
index 0f2b752..5b0ad08 100644
--- a/README.rst
+++ b/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
diff --git a/doc/source/contributor/.gitkeep b/doc/source/contributor/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/doc/source/cli.rst b/doc/source/contributor/cli.rst
similarity index 100%
rename from doc/source/cli.rst
rename to doc/source/contributor/cli.rst
diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst
similarity index 50%
rename from doc/source/contributing.rst
rename to doc/source/contributor/contributing.rst
index 1728a61..2aa0707 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributor/contributing.rst
@@ -1,4 +1,4 @@
 ============
 Contributing
 ============
-.. include:: ../../CONTRIBUTING.rst
+.. include:: ../../../CONTRIBUTING.rst
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
new file mode 100644
index 0000000..12f2c8f
--- /dev/null
+++ b/doc/source/contributor/index.rst
@@ -0,0 +1,5 @@
+Developer's Reference
+=====================
+
+.. toctree::
+   :maxdepth: 1
diff --git a/doc/source/installation.rst b/doc/source/contributor/installation.rst
similarity index 100%
rename from doc/source/installation.rst
rename to doc/source/contributor/installation.rst
diff --git a/doc/source/contributor/readme.rst b/doc/source/contributor/readme.rst
new file mode 100644
index 0000000..e4a3ad5
--- /dev/null
+++ b/doc/source/contributor/readme.rst
@@ -0,0 +1 @@
+.. include:: ../../../README.rst
diff --git a/doc/source/usage.rst b/doc/source/contributor/usage.rst
similarity index 100%
rename from doc/source/usage.rst
rename to doc/source/contributor/usage.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 3baa276..4e59d52 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -6,21 +6,28 @@
 Welcome to python-vitrageclient's documentation!
 ================================================
 
-Contents:
+Developer Guide
+---------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   readme
-   installation
-   usage
-   contributing
-   cli
+   contributor/readme
+   contributor/installation
+   contributor/usage
+   contributor/contributing
+   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`
-
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
deleted file mode 100644
index a6210d3..0000000
--- a/doc/source/readme.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. include:: ../../README.rst
diff --git a/setup.cfg b/setup.cfg
index eedfad6..e6c2e0f 100644
--- a/setup.cfg
+++ b/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