module docs are not being generated

The pbr section in setup.cfg is not defined, so the module docs are not being
generated. This causes the 404 when clicking on the ‘Module Index’ link under
the 'Indices and Tables’ section in [0].

[0] http://docs.openstack.org/developer/mistral/

Change-Id: I337e9f6e78257a3e8e9222779dfcd600ba6cebd8
Closes-bug: #1558574
This commit is contained in:
Nina Goradia 2016-03-17 12:12:01 -05:00
parent 411bedc4dc
commit fdb24bd697
4 changed files with 11 additions and 0 deletions

3
.gitignore vendored
View File

@ -52,3 +52,6 @@ tools/pylint_exceptions
# Files created by releasenotes build
releasenotes/build
# Files created by doc build
doc/source/api

View File

@ -91,6 +91,9 @@ if on_rtd:
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
# A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['mistral.']
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = 'Mistral'

View File

@ -26,6 +26,9 @@ source-dir = doc/source
build-dir = doc/build
all_files = 1
[pbr]
autodoc_tree_index_modules = True
[upload_sphinx]
upload-dir = doc/build/html

View File

@ -42,7 +42,9 @@ commands =
[testenv:venv]
commands = {posargs}
#set PYTHONHASHSEED=0 to prevent wsmeext.sphinxext from randomly failing.
[testenv:docs]
setenv = PYTHONHASHSEED=0
commands = python setup.py build_sphinx
[testenv:pylint]