Add publish-openstack-docs-pti to .zuul.yaml

This commit adds publish-openstack-docs-pti job to .zuul.yaml to verify
the rst files. To build the document, this commit also updates doc
related things such as requirements.txt, conf.py and the docs task in
tox.ini.

Change-Id: I4d1378a1972cad6f965d5cac6567d56828f75fb7

.zuul.yaml

@@ -1,3 +1,4 @@
 - project:
     templates:
       - openstack-python3-ussuri-jobs
+      - publish-openstack-docs-pti

doc/requirements.txt

@@ -0,0 +1,7 @@
+# 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.
+openstackdocstheme>=1.20.0 # Apache-2.0
+reno>=2.5.0 # Apache-2.0
+sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
+sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

doc/source/conf.py

@@ -18,13 +18,22 @@ import sys
 sys.path.insert(0, os.path.abspath('../..'))
 # -- General configuration ----------------------------------------------------
 
-# Add any Sphinx extension module names here, as strings. They can be
+# If your documentation needs a minimal Sphinx version, state it here.
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+#needs_sphinx = '1.0'
-extensions = [
+
-    'sphinx.ext.autodoc',
+# Add any Sphinx extension module names here, as strings. They can be extensions
-    #'sphinx.ext.intersphinx',
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-    'oslosphinx'
+extensions = ['sphinx.ext.autodoc',
-]
+              'sphinx.ext.todo',
+              'sphinx.ext.viewcode',
+              'sphinxcontrib.rsvgconverter',
+              'openstackdocstheme',
+             ]
+
+# openstackdocstheme options
+repository_name = 'openstack/devstack-tools'
+bug_project = 'devstack-tools'
+bug_tag = 'doc'
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
@@ -50,26 +59,92 @@ add_module_names = True
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-# -- Options for HTML output --------------------------------------------------
+# -- Options for HTML output ---------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# The theme to use for HTML and HTML Help pages.  See the documentation for
-# Sphinx are currently 'default' and 'sphinxdoc'.
+# a list of builtin themes.
-# html_theme_path = ["."]
+html_theme = 'openstackdocs'
-# html_theme = '_theme'
-# html_static_path = ['static']
 
-# Output file base name for HTML help builder.
+# Theme options are theme-specific and customize the look and feel of a theme
-htmlhelp_basename = '%sdoc' % project
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
+# Add any paths that contain "extra" files, such as .htaccess or
+# robots.txt.
+#html_extra_path = ['_extra']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+html_domain_indices = False
+
+# If false, no index is generated.
+html_use_index = False
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# A list of warning types to suppress arbitrary warning messages.
+suppress_warnings = ['image.nonlocal_uri']
+
+# -- Options for LaTeX output -------------------------------------------------
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
-    ('index',
+    ('index', 'doc-tempest.tex', u'Tempest Testing Project',
-     '%s.tex' % project,
-     u'%s Documentation' % project,
      u'OpenStack Foundation', 'manual'),
 ]
 
-# Example configuration for intersphinx: refer to the Python standard library.
+# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
-#intersphinx_mapping = {'http://docs.python.org/': None}
+latex_use_xindy = False

test-requirements.txt

@@ -2,16 +2,11 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
-hacking>=3.0,<3.1.0 # Apache-2.0
+hacking>=3.0,<3.1.0;python_version>='3.5' # Apache-2.0
 
 coverage>=4.0 # Apache-2.0
 python-subunit>=0.0.18 # Apache-2.0/BSD
-sphinx>=1.2.1,!=1.3b1,<1.4 # BSD
 fixtures
-oslosphinx>=4.7.0 # Apache-2.0
 oslotest>=1.10.0 # Apache-2.0
 testrepository>=0.0.18  # Apache-2.0/BSD
 testtools>=1.4.0 # MIT
-
-# releasenotes
-reno>=1.8.0 # Apache-2.0

tox.ini

@@ -24,7 +24,14 @@ commands = {posargs}
 commands = python setup.py test --coverage --testr-args='{posargs}'
 
 [testenv:docs]
-commands = python setup.py build_sphinx
+deps =
+  -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+  -r{toxinidir}/requirements.txt
+  -r{toxinidir}/doc/requirements.txt
+commands =
+  rm -rf doc/build
+  sphinx-build -W -b html doc/source doc/build/html
+whitelist_externals = rm
 
 [testenv:releasenotes]
 commands =