From fdb24bd697ca2b256e4daa418f5deedc3877bdc5 Mon Sep 17 00:00:00 2001 From: Nina Goradia Date: Thu, 17 Mar 2016 12:12:01 -0500 Subject: [PATCH] module docs are not being generated MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- .gitignore | 3 +++ doc/source/conf.py | 3 +++ setup.cfg | 3 +++ tox.ini | 2 ++ 4 files changed, 11 insertions(+) diff --git a/.gitignore b/.gitignore index 43266408a..3f00c1606 100644 --- a/.gitignore +++ b/.gitignore @@ -52,3 +52,6 @@ tools/pylint_exceptions # Files created by releasenotes build releasenotes/build + +# Files created by doc build +doc/source/api diff --git a/doc/source/conf.py b/doc/source/conf.py index 7a0d9b615..cc01fcb3e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 # " v documentation". html_title = 'Mistral' diff --git a/setup.cfg b/setup.cfg index 70746e54d..df029d1a7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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 diff --git a/tox.ini b/tox.ini index 2a84068bd..35a000148 100644 --- a/tox.ini +++ b/tox.ini @@ -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]