From e2c322160ce41a1254ea0d3c8ab1ab4f8c7ba725 Mon Sep 17 00:00:00 2001
From: Ifat Afek <ifat.afek@nokia.com>
Date: Tue, 25 Jul 2017 09:22:18 +0000
Subject: [PATCH] Doc Migration: move the developer guide under
 doc/source/contributor folder

Change-Id: I63b61566867d095d680e99872e4659802e11f5fa
---
 README.rst                                    |  7 +++---
 doc/source/contributor/.gitkeep               |  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                          | 23 ++++++++++++-------
 doc/source/readme.rst                         |  1 -
 setup.cfg                                     |  1 +
 10 files changed, 26 insertions(+), 14 deletions(-)
 delete mode 100644 doc/source/contributor/.gitkeep
 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 59ac10c..db4e276 100644
--- a/README.rst
+++ b/README.rst
@@ -4,13 +4,12 @@ Team and repository tags
 
 .. image:: http://governance.openstack.org/badges/vitrage-dashboard.svg
     :target: http://governance.openstack.org/reference/tags/index.html
-    :remote:
 
 .. Change things from this point on
 
-=======
-Vitrage
-=======
+=================
+Vitrage Dashboard
+=================
 
 Vitrage is the Openstack RCA (Root Cause Analysis) Engine for organizing,
 analyzing and expanding OpenStack alarms & events, yielding insights
diff --git a/doc/source/contributor/.gitkeep b/doc/source/contributor/.gitkeep
deleted file mode 100644
index e69de29..0000000
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 c8d629f..c8f10fd 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -6,20 +6,27 @@
 Welcome to vitrage-dashboard's documentation!
 =============================================
 
-Contents:
+Developer Guide
+---------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   readme
-   installation
-   usage
-   contributing
+   contributor/readme
+   contributor/installation
+   contributor/usage
+   contributor/contributing
+
+.. # 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 68dfc9d..bc688d9 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -27,6 +27,7 @@ packages =
 source-dir = doc/source
 build-dir = doc/build
 all_files = 1
+warning-is-error = 1
 
 [upload_sphinx]
 upload-dir = doc/build/html