fdb24bd697
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
123 lines
3.9 KiB
Python
123 lines
3.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
# implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import os
|
|
import sys
|
|
|
|
|
|
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# 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('../'))
|
|
sys.path.insert(0, os.path.abspath('./'))
|
|
# -- General configuration ----------------------------------------------------
|
|
|
|
# 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',
|
|
'sphinxcontrib.autohttp.flask',
|
|
'sphinxcontrib.pecanwsme.rest',
|
|
'wsmeext.sphinxext',
|
|
]
|
|
|
|
if not on_rtd:
|
|
extensions.append('oslosphinx')
|
|
|
|
wsme_protocols = ['restjson']
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# 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
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = u'Mistral'
|
|
copyright = u'2014, Mistral Contributors'
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
# |version| and |release|, also used in various other places throughout the
|
|
# built documents.
|
|
from mistral.version import version_info
|
|
release = version_info.release_string()
|
|
version = version_info.version_string()
|
|
|
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
|
# output. They are ignored by default.
|
|
show_authors = False
|
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
add_function_parentheses = True
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
# unit titles (such as .. function::).
|
|
add_module_names = True
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# -- Options for HTML output --------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
# html_static_path = ['_static']
|
|
|
|
if on_rtd:
|
|
html_theme_path = ['.']
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
# 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'
|
|
|
|
# Custom sidebar templates, maps document names to template names.
|
|
html_sidebars = {
|
|
'index': [
|
|
'sidebarlinks.html', 'localtoc.html', 'searchbox.html', 'sourcelink.html'
|
|
],
|
|
'**': [
|
|
'localtoc.html', 'relations.html',
|
|
'searchbox.html', 'sourcelink.html'
|
|
]
|
|
}
|
|
|
|
# -- Options for manual page output -------------------------------------------
|
|
|
|
# One entry per manual page. List of tuples
|
|
# (source start file, name, description, authors, manual section).
|
|
man_pages = [
|
|
('index', 'mistral', u'Mistral',
|
|
[u'OpenStack Foundation'], 1)
|
|
]
|
|
|
|
# If true, show URL addresses after external links.
|
|
man_show_urls = True
|