Doc Migration: move the developer guide under doc/source/contributor folder

Change-Id: I63b61566867d095d680e99872e4659802e11f5fa
This commit is contained in:
Ifat Afek 2017-07-25 09:22:18 +00:00
parent f02f36cfae
commit e2c322160c
10 changed files with 26 additions and 14 deletions

View File

@ -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

View File

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

View File

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

View File

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

View File

@ -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`

View File

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

View File

@ -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