Change how path munging works for sphinx docs

The 'import tools' line is fragile as it depends on how things are
executed as to whether or not '.' is in the python path.

Do the sphinx path munging before importing it.

Also, remove reference to modules/autoindex which does not exist and
thus causes sadness from warning-is-error.

Moves documentation requirements into doc/requirements.txt

Depends-On: Ib121961c5a953a434e7b333cd70f7838a2671f69
Change-Id: I23691aa1d0ea038ec1215e6199015529ddd92de4

doc/requirements.txt

@@ -0,0 +1,16 @@
+# Docs
+os-api-ref>=1.4.0 # Apache-2.0
+sphinxcontrib-actdiag>=0.8.5 # BSD
+sphinxcontrib-blockdiag>=1.5.4 # BSD
+sphinxcontrib-nwdiag>=0.9.5 # BSD
+sphinxcontrib-seqdiag>=0.8.4 # BSD
+docutils>=0.11 # OSI-Approved Open Source, Public Domain
+sphinx>=1.6.2 # BSD
+graphviz!=0.5.0,>=0.4 # MIT License
+openstackdocstheme>=1.17.0 # Apache-2.0
+sadisplay>=0.4.8 # BSD
+
+# This needs to be installed after above modules
+pydotplus>=2.0.2 # MIT License
+pyparsing>=2.1.0 # MIT
+networkx<2.0,>=1.10 # BSD

doc/source/conf.py

@@ -3,7 +3,8 @@
 # Tempest documentation build configuration file, created by
 # sphinx-quickstart on Tue May 21 17:43:32 2013.
 #
-# This file is execfile()d with the current directory set to its containing dir.
+# This file is execfile()d with the current directory set to its containing
+# dir.
 #
 # Note that not all possible configuration values are present in this
 # autogenerated file.
@@ -11,14 +12,18 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
-import subprocess
 import os
+import sys
 
 from pydotplus import graphviz
 import sadisplay
+from sphinx import apidoc
 
 import octavia.db.models as models
+
+sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath('.'))
+
 from tools import create_flow_docs
 
 # Generate our flow diagrams
@@ -39,16 +44,17 @@ graph.write('contributor/devref/erd.svg', format='svg')
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('../../octavia'))
 
-# -- General configuration -----------------------------------------------------
+# -- General configuration ----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 # needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be extensions
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc',
+extensions = [
+    'sphinx.ext.autodoc',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
     'sphinxcontrib.blockdiag',
@@ -91,11 +97,14 @@ copyright = u'2014, OpenStack Octavia Team'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build',
+exclude_patterns = [
+    '_build',
     'contributor/specs/skeleton.rst',
-                    'contributor/specs/template.rst']
+    'contributor/specs/template.rst'
+]
 
-# The reST default role (used for this markup: `text`) to use for all documents.
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
 # default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
@@ -118,7 +127,7 @@ modindex_common_prefix = ['octavia.']
 # -- Options for man page output ----------------------------------------------
 man_pages = []
 
-# -- Options for HTML output ---------------------------------------------------
+# -- Options for HTML output --------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
@@ -195,7 +204,7 @@ html_use_index = True
 htmlhelp_basename = 'Octavia-Specsdoc'
 
 
-# -- Options for LaTeX output --------------------------------------------------
+# -- Options for LaTeX output -------------------------------------------------
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
@@ -209,11 +218,15 @@ latex_elements = {
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
+# (source start file, target name, title, author, documentclass
-latex_documents = [
+# [howto/manual]).
-  ('index', 'Octavia-specs.tex', u'Octavia Specs',
+latex_documents = [(
-   u'OpenStack Octavia Team', 'manual'),
+    'index',
-]
+    'Octavia-specs.tex',
+    u'Octavia Specs',
+    u'OpenStack Octavia Team',
+    'manual'
+)]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
@@ -235,16 +248,20 @@ latex_documents = [
 # If false, no module index is generated.
 # latex_domain_indices = True
 
-# -- Options for Texinfo output ------------------------------------------------
+# -- Options for Texinfo output -----------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
-texinfo_documents = [
+texinfo_documents = [(
-  ('index', 'Octavia-specs', u'Octavia Design Specs',
+    'index',
-   u'OpenStack Octavia Team', 'octavia-specs', 'Design specifications for the Octavia project.',
+    'Octavia-specs',
-   'Miscellaneous'),
+    u'Octavia Design Specs',
-]
+    u'OpenStack Octavia Team',
+    'octavia-specs',
+    'Design specifications for the Octavia project.',
+    'Miscellaneous'
+)]
 
 # Documents to append as an appendix to all manuals.
 # texinfo_appendices = []
@@ -256,7 +273,7 @@ texinfo_documents = [
 # texinfo_show_urls = 'footnote'
 
 
-# -- Options for Epub output ---------------------------------------------------
+# -- Options for Epub output --------------------------------------------------
 
 # Bibliographic Dublin Core info.
 epub_title = u'Octavia Specs'
@@ -304,8 +321,31 @@ sample_policy_basename = 'configuration/_static/octavia'
 
 # openstackdocstheme options
 html_theme_options = {
-    "display_toc": False
+    'display_toc': False
 }
 repository_name = 'openstack/octavia'
 bug_project = 'octavia'
 bug_tag = 'docs'
+
+
+# TODO(mordred) We should extract this into a sphinx plugin
+def run_apidoc(_):
+    cur_dir = os.path.abspath(os.path.dirname(__file__))
+    out_dir = os.path.join(cur_dir, 'contributor', 'modules')
+    module = os.path.join(cur_dir, '..', '..', 'octavia')
+    # Keep the order of arguments same as the sphinx-apidoc help, otherwise it
+    # would cause unexpected errors:
+    # sphinx-apidoc [options] -o <output_path> <module_path>
+    # [exclude_pattern, ...]
+    apidoc.main([
+        '--force',
+        '-o',
+        out_dir,
+        module,
+        'octavia/tests',
+        'octavia/db/migration'
+    ])
+
+
+def setup(app):
+    app.connect('builder-inited', run_apidoc)

doc/source/contributor/index.rst

@@ -89,7 +89,7 @@ Indices and Search
 .. toctree::
    :hidden:
 
-   modules/autoindex
+   modules/modules
 
 * :ref:`genindex`
 * :ref:`modindex`

setup.cfg

@@ -49,7 +49,7 @@ autodoc_tree_excludes =
     setup.py
     octavia/tests/
     octavia/db/migration/
-autodoc_index_modules = True
+autodoc_index_modules = False
 autodoc_exclude_modules =
     octavia.tests.*
     octavia.db.migration.*

test-requirements.txt

@@ -7,7 +7,6 @@ coverage!=4.4,>=4.0 # Apache-2.0
 flake8-import-order==0.12 # LGPLv3
 mock>=2.0.0 # BSD
 python-subunit>=1.0.0 # Apache-2.0/BSD
-os-api-ref>=1.4.0 # Apache-2.0
 oslotest>=1.10.0 # Apache-2.0
 pylint==1.4.5 # GPLv2
 testrepository>=0.0.18 # Apache-2.0/BSD
@@ -18,20 +17,5 @@ doc8>=0.6.0 # Apache-2.0
 reno>=2.5.0 # Apache-2.0
 bandit>=1.1.0 # Apache-2.0
 tempest>=17.1.0 # Apache-2.0
-
+# Required for pep8 - doc8 tests
-# Docs
-sphinxcontrib-actdiag>=0.8.5 # BSD
-sphinxcontrib-blockdiag>=1.5.4 # BSD
-sphinxcontrib-nwdiag>=0.9.5 # BSD
-sphinxcontrib-seqdiag>=0.8.4 # BSD
-docutils>=0.11 # OSI-Approved Open Source, Public Domain
 sphinx>=1.6.2 # BSD
-graphviz!=0.5.0,>=0.4 # MIT License
-openstackdocstheme>=1.17.0 # Apache-2.0
-sadisplay>=0.4.8 # BSD
-
-# This needs to be installed after above modules
-pydotplus>=2.0.2 # MIT License
-pyparsing>=2.1.0 # MIT
-networkx<2.0,>=1.10 # BSD
-

tox.ini

@@ -71,10 +71,14 @@ whitelist_externals =
   find
 
 [testenv:docs]
+deps =
+    -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
+    -r{toxinidir}/requirements.txt
+    -r{toxinidir}/doc/requirements.txt
 whitelist_externals = rm
 commands =
   rm -rf doc/build api-guide/build api-ref/build
-  python setup.py build_sphinx
+  sphinx-build -W -b html doc/source doc/build/html
   sphinx-build -W -b html api-ref/source api-ref/build/html
 
 [testenv:venv]