8f8a4ea4ec
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I9f2636a01516ae757b17d47081c890f855c3eb5d
129 lines
4.1 KiB
Python
129 lines
4.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 = [
|
|
'sphinx.ext.autodoc',
|
|
#'sphinx.ext.intersphinx',
|
|
'openstackdocstheme',
|
|
'oslo_config.sphinxext',
|
|
'oslo_config.sphinxconfiggen',
|
|
'oslo_policy.sphinxext',
|
|
'oslo_policy.sphinxpolicygen',
|
|
'sphinxcontrib.rsvgconverter',
|
|
]
|
|
|
|
# openstackdocstheme options
|
|
openstackdocs_repo_name = 'openstack/neutron-dynamic-routing'
|
|
openstackdocs_pdf_link = True
|
|
openstackdocs_auto_name = False
|
|
openstackdocs_bug_project = 'neutron'
|
|
openstackdocs_bug_tag = 'doc'
|
|
|
|
# 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'neutron-dynamic-routing'
|
|
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 = 'native'
|
|
|
|
# -- 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_path = ["."]
|
|
# html_theme = '_theme'
|
|
html_theme = 'openstackdocs'
|
|
html_static_path = ['_static']
|
|
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = '%sdoc' % project
|
|
|
|
# -- Options for LaTeX output -------------------------------------------------
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title, author, documentclass
|
|
# [howto/manual], torctree_only).
|
|
latex_documents = [
|
|
('index',
|
|
'doc-%s.tex' % project,
|
|
u'%s Documentation' % project,
|
|
u'OpenStack Foundation', 'manual',
|
|
# Specify toctree_only=True for a better document structure of
|
|
# the generated PDF file.
|
|
True),
|
|
]
|
|
|
|
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
|
|
latex_use_xindy = False
|
|
|
|
latex_domain_indices = False
|
|
|
|
latex_elements = {
|
|
'makeindex': '',
|
|
'printindex': '',
|
|
'preamble': r'\setcounter{tocdepth}{3}',
|
|
}
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
#intersphinx_mapping = {'http://docs.python.org/': None}
|
|
|
|
# -- Options for oslo_config.sphinxconfiggen ---------------------------------
|
|
|
|
_config_generator_config_files = [
|
|
'bgp_dragent.ini',
|
|
]
|
|
|
|
def _get_config_generator_config_definition(conf):
|
|
config_file_path = '../../etc/oslo-config-generator/%s' % conf
|
|
# oslo_config.sphinxconfiggen appends '.conf.sample' to the filename,
|
|
# strip file extentension (.conf or .ini).
|
|
output_file_path = '_static/config_samples/%s' % conf.rsplit('.', 1)[0]
|
|
return (config_file_path, output_file_path)
|
|
|
|
|
|
config_generator_config_file = [
|
|
_get_config_generator_config_definition(conf)
|
|
for conf in _config_generator_config_files
|
|
]
|
|
|
|
# -- Options for oslo_policy.sphinxpolicygen ---------------------------------
|
|
|
|
policy_generator_config_file = '../../etc/oslo-policy-generator/policy.conf'
|
|
sample_policy_basename = '_static/neutron-dynamic-routing'
|