87 lines
2.6 KiB
Python
87 lines
2.6 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.
|
|
#
|
|
# python-novaclient documentation build configuration file
|
|
|
|
# -- 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 = [
|
|
'openstackdocstheme',
|
|
'sphinx.ext.autodoc',
|
|
'sphinxcontrib.apidoc',
|
|
]
|
|
|
|
# sphinxcontrib.apidoc options
|
|
apidoc_module_dir = '../../novaclient'
|
|
apidoc_output_dir = 'reference/api'
|
|
apidoc_excluded_paths = [
|
|
'tests/*']
|
|
apidoc_separate_modules = True
|
|
|
|
# The content that will be inserted into the main body of an autoclass
|
|
# directive.
|
|
autoclass_content = 'both'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
copyright = 'OpenStack Contributors'
|
|
|
|
|
|
# -- 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_theme = 'openstackdocs'
|
|
|
|
# Add any paths that contain "extra" files, such as .htaccess or
|
|
# robots.txt.
|
|
html_extra_path = ['_extra']
|
|
|
|
|
|
# -- Options for LaTeX output -------------------------------------------------
|
|
|
|
latex_documents = [
|
|
('index', 'doc-python-novaclient.tex', 'python-novaclient Documentation',
|
|
'OpenStack Foundation', 'manual'),
|
|
]
|
|
|
|
latex_elements = {
|
|
'extraclassoptions': 'openany,oneside',
|
|
'preamble': r'\setcounter{tocdepth}{4}',
|
|
'makeindex': '',
|
|
'printindex': '',
|
|
}
|
|
|
|
# -- Options for openstackdocstheme -------------------------------------------
|
|
|
|
openstackdocs_repo_name = 'openstack/python-novaclient'
|
|
openstackdocs_bug_project = 'python-novaclient'
|
|
openstackdocs_bug_tag = ''
|
|
openstackdocs_projects = [
|
|
'keystoneauth',
|
|
'nova',
|
|
'os-client-config',
|
|
'python-openstackclient',
|
|
]
|
|
|
|
# -- Options for manual page output ------------------------------------------
|
|
|
|
# One entry per manual page. List of tuples
|
|
# (source start file, name, description, authors, manual section).
|
|
man_pages = [
|
|
('cli/nova', 'nova', 'OpenStack Nova command line client',
|
|
['OpenStack Contributors'], 1),
|
|
]
|