diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..827758f --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,5 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +openstackdocstheme>=1.18.1 # Apache-2.0 diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 3034cb1..208b653 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -3,12 +3,12 @@ Contributing ============ General Info -============ +------------ .. include:: ../../../CONTRIBUTING.rst Approved Specs -============== +-------------- .. toctree:: :maxdepth: 1 diff --git a/doc/source/index.rst b/doc/source/index.rst index b886580..d8d19db 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,7 +1,8 @@ Welcome to karborclient's documentation! -======================================================== +======================================== -Contents: +Contents +-------- .. toctree:: :maxdepth: 1 @@ -12,9 +13,8 @@ Contents: contributor/index Indices and tables -================== +------------------ * :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff --git a/doc/source/readme.rst b/doc/source/readme.rst index 4d248c1..5c28058 100644 --- a/doc/source/readme.rst +++ b/doc/source/readme.rst @@ -1,5 +1,5 @@ -############ +============ Introduction -############ +============ .. include:: ../../README.rst diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index f4df4a9..50f0607 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -1,6 +1,6 @@ -======== +===== Usage -======== +===== To use karborclient in a project:: diff --git a/setup.cfg b/setup.cfg index dc8373a..1e82e7a 100644 --- a/setup.cfg +++ b/setup.cfg @@ -89,14 +89,5 @@ keywords = _ gettext ngettext l_ lazy_gettext mapping_file = babel.cfg output_file = karborclient/locale/karborclient.pot -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 -warning-is-error = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [wheel] universal = 1 diff --git a/test-requirements.txt b/test-requirements.txt index 8f7e885..27e5330 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,8 +7,6 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD docutils>=0.11 # OSI-Approved Open Source, Public Domain -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 python-openstackclient>=3.12.0 # Apache-2.0 requests-mock>=1.2.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index f87512e..35e1629 100644 --- a/tox.ini +++ b/tox.ini @@ -30,7 +30,8 @@ commands = coverage report [testenv:docs] -commands = python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -W -b html doc/source doc/build/html [testenv:debug] commands = oslo_debug_helper -t karborclient/tests {posargs} @@ -38,6 +39,6 @@ commands = oslo_debug_helper -t karborclient/tests {posargs} [flake8] show-source = True -ignore = +ignore = builtins = _ exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools