From a2d5654879c4ba2540c04020497a48b397986124 Mon Sep 17 00:00:00 2001 From: Luz Cazares Date: Fri, 17 Nov 2017 23:20:58 +0000 Subject: [PATCH] Fix documentation tree Fixed autogenerated sphinx documentation main tree to include all approved specs. Change-Id: Icb5cc6bf87a75929e9a683ac98ab512c69a945a7 --- doc/source/index.rst | 22 +++++++++++++++------- setup.cfg | 5 +++++ specs/newton/approved/refstack-waiver.rst | 7 +++---- tox.ini | 2 +- 4 files changed, 24 insertions(+), 12 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 27256d4..73a8074 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,20 +1,28 @@ +=========================================== Welcome to refstack-client's documentation! =========================================== -Contents: ------------ +--------------------- +About refstack-client +--------------------- .. toctree:: - :maxdepth: 4 - :glob: + :maxdepth: 2 readme - specs/newton/approved/* +----------------- +Approved Features +----------------- - specs/newton/implemented/* +.. toctree:: + :titlesonly: + :glob: + specs/*/approved/* + +------------------ Indices and tables -================== +------------------ * :ref:`search` diff --git a/setup.cfg b/setup.cfg index 8d2e5cc..3962ed4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -30,3 +30,8 @@ setup-hooks = [entry_points] console_scripts = refstack-client = refstack_client.refstack_client:entry_point + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source diff --git a/specs/newton/approved/refstack-waiver.rst b/specs/newton/approved/refstack-waiver.rst index c0b26b7..015fab7 100644 --- a/specs/newton/approved/refstack-waiver.rst +++ b/specs/newton/approved/refstack-waiver.rst @@ -1,7 +1,6 @@ -====================================================================== -Refstack-client implementation of Defcore waiver regarding additional -properties on Nova API response -====================================================================== +============================================================= +Defcore waiver for additional properties on Nova API response +============================================================= Launchpad blueprint: https://blueprints.launchpad.net/refstack/+spec/refstack-waiver diff --git a/tox.ini b/tox.ini index b07c13b..83683a6 100644 --- a/tox.ini +++ b/tox.ini @@ -34,7 +34,7 @@ commands = coverage run \ /bin/rm .coverage [testenv:docs] -commands = python setup.py build_sphinx +commands = python setup.py build_sphinx {posargs} [flake8] # E125 continuation line does not distinguish itself from next logical line