Docs: arrange guides

Change-Id: I956d0137f3c1507d58aac0d9b22b6737473e55be
This commit is contained in:
Yuval Brik
2017-07-27 12:10:38 +03:00
parent 423e4d5b48
commit d5842f6196
9 changed files with 39 additions and 8 deletions

View File

@@ -7,6 +7,7 @@ Team and repository tags
.. Change things from this point on .. Change things from this point on
======
Karbor Karbor
====== ======

View File

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

View File

@@ -0,0 +1,16 @@
============
Contributing
============
General Info
============
.. include:: ../../../CONTRIBUTING.rst
Approved Specs
==============
.. toctree::
:maxdepth: 1
../specs/index

View File

@@ -4,12 +4,12 @@ Welcome to karborclient's documentation!
Contents: Contents:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
readme readme
installation install/index
usage user/index
contributing contributor/index
Indices and tables Indices and tables
================== ==================

View File

@@ -1 +1,5 @@
############
Introduction
############
.. include:: ../../README.rst .. include:: ../../README.rst

View File

@@ -0,0 +1,13 @@
Specs
=====
This section contains detailed specification documents for
different features inside Karbor Client.
Approved Specs
--------------
.. toctree::
:maxdepth: 1
karbor-support-in-python-openstackclient

View File

@@ -82,6 +82,7 @@ output_file = karborclient/locale/karborclient.pot
source-dir = doc/source source-dir = doc/source
build-dir = doc/build build-dir = doc/build
all_files = 1 all_files = 1
warning-is-error = 1
[upload_sphinx] [upload_sphinx]
upload-dir = doc/build/html upload-dir = doc/build/html