Merge "Follow the new PTI for document build"

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

doc/source/contributor/index.rst

@@ -3,12 +3,12 @@ Contributing
 ============
 
 General Info
-============
+------------
 
 .. include:: ../../../CONTRIBUTING.rst
 
 Approved Specs
-==============
+--------------
 
 .. toctree::
    :maxdepth: 1

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`
 

doc/source/readme.rst

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

doc/source/user/index.rst

@@ -1,6 +1,6 @@
-========
+=====
 Usage
-========
+=====
 
 To use karborclient in a project::
 

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

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

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,7 +39,7 @@ 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