009c9a59e6
The module index for tacker docs is dropped due to new PTI for building docs. However, sphinxcontrib.apidoc now support to build autodoc which replace pbr autodoc. We can have it again. Closes-Bug: #1761923 Change-Id: Ie4c98dd6e8b365778cb0d2c377a9600d79cb43d1
102 lines
3.1 KiB
Python
102 lines
3.1 KiB
Python
# 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
|
|
|
|
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 = [
|
|
'sphinxcontrib.apidoc',
|
|
'stevedore.sphinxext',
|
|
'openstackdocstheme',
|
|
]
|
|
|
|
# sphinxcontrib.apidoc options
|
|
apidoc_module_dir = '../../tacker'
|
|
apidoc_output_dir = 'contributor/api'
|
|
apidoc_excluded_paths = [
|
|
'tests/*',
|
|
'tests',
|
|
'nfvo/workflows/*',
|
|
'nfvo/workflows',
|
|
'vnfm/workflows/*',
|
|
'vnfm/workflows',
|
|
'db/migration/alembic_migrations/*',
|
|
'db/migration/alembic_migrations',
|
|
'hacking']
|
|
apidoc_separate_modules = True
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = u'tacker'
|
|
copyright = u'2013, OpenStack Foundation'
|
|
|
|
# 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'
|
|
|
|
# A list of ignored prefixes for module index sorting.
|
|
modindex_common_prefix = ['tacker.']
|
|
|
|
# -- Options for HTML output --------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
|
# Sphinx are currently 'default' and 'sphinxdoc'.
|
|
# html_static_path = ['static']
|
|
html_theme = 'openstackdocs'
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = '%sdoc' % project
|
|
|
|
# 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.
|
|
# html_last_updated_fmt = '%b %d, %Y'
|
|
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title, author, documentclass
|
|
# [howto/manual]).
|
|
latex_documents = [
|
|
('index',
|
|
'%s.tex' % project,
|
|
u'%s Documentation' % project,
|
|
u'OpenStack Foundation', 'manual'),
|
|
]
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
#intersphinx_mapping = {'http://docs.python.org/': None}
|
|
|
|
# -- Options for openstackdocstheme -------------------------------------------
|
|
repository_name = 'openstack/tacker'
|
|
bug_project = 'tacker'
|
|
bug_tag = ''
|