Adds tox docs job

Follow PTI for this and add all needed changes, remove obsolete
options. Switch to openstackdocstheme instead of oslosphinx
since that is retired.

Remove module index - this repo has no modules and thus nothing is
generated.

Add job to publish documents.

Change-Id: Ida269f9755099f32a12f46082b529311ecb7e2b6

.zuul.yaml

@@ -2,3 +2,4 @@
     templates:
       - openstack-python-jobs-no-constraints
       - openstack-python35-jobs-no-constraints
+      - publish-openstack-docs-pti

CONTRIBUTING.rst

@@ -1,3 +1,7 @@
+============
+Contributing
+============
+
 If you would like to contribute to the development of OpenStack,
 you must follow the steps in this page:
 

doc/requirements.txt

@@ -0,0 +1,3 @@
+sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
+sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4'  # BSD
+openstackdocstheme>=1.20 # Apache-2.0

doc/source/conf.py

@@ -23,9 +23,14 @@ sys.path.insert(0, os.path.abspath('../..'))
 extensions = [
     'sphinx.ext.autodoc',
     #'sphinx.ext.intersphinx',
-    'oslo.sphinx'
+    'openstackdocstheme'
 ]
 
+# openstackdocstheme options
+repository_name = 'openstack/reviewstats'
+use_storyboard = True
+html_theme = 'openstackdocs'
+
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
 # execute "export SPHINX_DEBUG=1" in your terminal to disable

doc/source/index.rst

@@ -1,7 +1,9 @@
+=======================================
 Welcome to reviewstats's documentation!
 =======================================
 
-Contents:
+Contents
+========
 
 .. toctree::
    :maxdepth: 2
@@ -15,5 +17,4 @@ Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`

doc/source/readme.rst

@@ -1 +1 @@
-.. include:: ../README.rst
+.. include:: ../../README.rst

doc/source/usage.rst

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

setup.cfg

@@ -22,14 +22,6 @@ classifier =
 packages =
     reviewstats
 
-[build_sphinx]
-source-dir = doc/source
-build-dir = doc/build
-all_files = 1
-
-[upload_sphinx]
-upload-dir = doc/build/html
-
 [compile_catalog]
 directory = reviewstats/locale
 domain = reviewstats

test-requirements.txt

@@ -3,8 +3,6 @@ hacking>=0.5.6,<0.8
 coverage>=3.6
 fixtures>=0.3.14
 python-subunit
-sphinx>=1.1.2,<1.2
-oslo.sphinx
 testrepository>=0.0.17
 testscenarios>=0.4,<0.5
 testtools>=0.9.32

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 minversion = 1.6
-envlist = py27,py35,pypy,pep8
+envlist = py27,py35,pypy,pep8,docs
 skipsdist = True
 
 [testenv]
@@ -12,6 +12,11 @@ deps = -r{toxinidir}/requirements.txt
        -r{toxinidir}/test-requirements.txt
 commands = python setup.py testr --slowest --testr-args='{posargs}'
 
+[testenv:docs]
+basepython = python3
+deps = -r{toxinidir}/doc/requirements.txt
+commands = sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
+
 [testenv:pep8]
 commands = flake8