| 1 |
# -*- coding: utf-8 -*- |
| 2 |
# |
| 3 |
|
| 4 |
# -- General configuration --------------------------------------------- |
| 5 |
|
| 6 |
# Add any Sphinx extension module names here, as strings. They can be |
| 7 |
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
| 8 |
extensions = [ |
| 9 |
'sphinx.ext.autodoc', |
| 10 |
'reno.sphinxext', |
| 11 |
'openstackdocstheme', |
| 12 |
'cliff.sphinxext', |
| 13 |
] |
| 14 |
|
| 15 |
# openstackdocstheme options |
| 16 |
openstackdocs_repo_name = 'openstack/python-neutronclient' |
| 17 |
openstackdocs_pdf_link = True |
| 18 |
openstackdocs_bug_project = 'python-neutronclient' |
| 19 |
openstackdocs_bug_tag = 'doc' |
| 20 |
|
| 21 |
# Add any paths that contain templates here, relative to this directory. |
| 22 |
templates_path = ['_templates'] |
| 23 |
|
| 24 |
# The suffix of source filenames. |
| 25 |
source_suffix = '.rst' |
| 26 |
|
| 27 |
# The master toctree document. |
| 28 |
master_doc = 'index' |
| 29 |
|
| 30 |
# General information about the project. |
| 31 |
copyright = 'OpenStack Foundation' |
| 32 |
|
| 33 |
# If true, '()' will be appended to :func: etc. cross-reference text. |
| 34 |
add_function_parentheses = True |
| 35 |
|
| 36 |
# If true, the current module name will be prepended to all description |
| 37 |
# unit titles (such as .. function::). |
| 38 |
add_module_names = True |
| 39 |
|
| 40 |
# The name of the Pygments (syntax highlighting) style to use. |
| 41 |
pygments_style = 'sphinx' |
| 42 |
|
| 43 |
# -- Options for HTML output --------------------------------------------- |
| 44 |
|
| 45 |
# The theme to use for HTML and HTML Help pages. Major themes that come with |
| 46 |
# Sphinx are currently 'default' and 'sphinxdoc'. |
| 47 |
html_theme = 'openstackdocs' |
| 48 |
|
| 49 |
# Output file base name for HTML help builder. |
| 50 |
htmlhelp_basename = 'neutronclientdoc' |
| 51 |
|
| 52 |
# -- Options for LaTeX output ------------------------------------------------ |
| 53 |
|
| 54 |
latex_documents = [ |
| 55 |
('index', 'doc-python-neutronclient.tex', |
| 56 |
'python-neutronclient Documentation', |
| 57 |
'Neutron Contributors', 'manual'), |
| 58 |
] |
| 59 |
|
| 60 |
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664 |
| 61 |
latex_use_xindy = False |
| 62 |
|
| 63 |
latex_domain_indices = False |
| 64 |
|
| 65 |
latex_elements = { |
| 66 |
'makeindex': '', |
| 67 |
'printindex': '', |
| 68 |
'preamble': r'\setcounter{tocdepth}{5}', |
| 69 |
} |
| 70 |
|
| 71 |
# -- Options for cliff.sphinxext plugin --------------------------------------- |
| 72 |
|
| 73 |
autoprogram_cliff_application = 'openstack' |