From d5842f61962b72f093b750b864ec2d0b584f671a Mon Sep 17 00:00:00 2001 From: Yuval Brik Date: Thu, 27 Jul 2017 12:10:38 +0300 Subject: [PATCH] Docs: arrange guides Change-Id: I956d0137f3c1507d58aac0d9b22b6737473e55be --- README.rst | 1 + doc/source/contributing.rst | 4 ---- doc/source/contributor/index.rst | 16 ++++++++++++++++ doc/source/index.rst | 8 ++++---- .../{installation.rst => install/index.rst} | 0 doc/source/readme.rst | 4 ++++ doc/source/specs/index.rst | 13 +++++++++++++ doc/source/{usage.rst => user/index.rst} | 0 setup.cfg | 1 + 9 files changed, 39 insertions(+), 8 deletions(-) delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/index.rst rename doc/source/{installation.rst => install/index.rst} (100%) create mode 100644 doc/source/specs/index.rst rename doc/source/{usage.rst => user/index.rst} (100%) diff --git a/README.rst b/README.rst index 3f087d2..5cec781 100644 --- a/README.rst +++ b/README.rst @@ -7,6 +7,7 @@ Team and repository tags .. Change things from this point on +====== Karbor ====== diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 1728a61..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..3034cb1 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,16 @@ +============ +Contributing +============ + +General Info +============ + +.. include:: ../../../CONTRIBUTING.rst + +Approved Specs +============== + +.. toctree:: + :maxdepth: 1 + + ../specs/index diff --git a/doc/source/index.rst b/doc/source/index.rst index 109d4d6..b886580 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -4,12 +4,12 @@ Welcome to karborclient's documentation! Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 readme - installation - usage - contributing + install/index + user/index + contributor/index Indices and tables ================== diff --git a/doc/source/installation.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst diff --git a/doc/source/readme.rst b/doc/source/readme.rst index a6210d3..4d248c1 100644 --- a/doc/source/readme.rst +++ b/doc/source/readme.rst @@ -1 +1,5 @@ +############ +Introduction +############ + .. include:: ../../README.rst diff --git a/doc/source/specs/index.rst b/doc/source/specs/index.rst new file mode 100644 index 0000000..a100ffb --- /dev/null +++ b/doc/source/specs/index.rst @@ -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 diff --git a/doc/source/usage.rst b/doc/source/user/index.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/index.rst diff --git a/setup.cfg b/setup.cfg index 9b56761..7497a50 100644 --- a/setup.cfg +++ b/setup.cfg @@ -82,6 +82,7 @@ output_file = karborclient/locale/karborclient.pot source-dir = doc/source build-dir = doc/build all_files = 1 +warning-is-error = 1 [upload_sphinx] upload-dir = doc/build/html