30fdf5ff21
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. 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. Set openstackdocs_auto_name to use 'project' 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. Depends-On: https://review.opendev.org/729744 Change-Id: Ia2c49cfc3a933a04d6ee4aea6c827935bebd3c41
83 lines
2.6 KiB
Python
83 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.
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
needs_sphinx = '1.6'
|
|
|
|
# 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',
|
|
'reno.sphinxext'
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The encoding of source files.
|
|
source_encoding = 'utf-8'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
openstackdocs_repo_name = u'openstack/python-monascaclient'
|
|
project = u'Monasca Client ReleaseNotes Docs'
|
|
|
|
# Release notes do not need a version number in the title, they
|
|
# cover multiple releases.
|
|
version = ''
|
|
release = ''
|
|
openstackdocs_use_storyboard = True
|
|
openstackdocs_auto_name = False
|
|
copyright = u'2014-present, OpenStack Foundation'
|
|
author = u'OpenStack Foundation'
|
|
|
|
# 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. See the documentation for
|
|
# a list of builtin themes.
|
|
html_theme = 'openstackdocs'
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'MonascaClientReleaseNotesDoc'
|
|
|
|
# -- Options for LaTeX output ---------------------------------------------
|
|
|
|
latex_documents = [(
|
|
master_doc, 'MonascaClientReleaseNotes.tex',
|
|
u'Monasca Client Release Notes', [author],
|
|
'manual'
|
|
)]
|
|
|
|
# -- Options for manual page output ---------------------------------------
|
|
|
|
# One entry per manual page. List of tuples
|
|
# (source start file, name, description, authors, manual section).
|
|
man_pages = [
|
|
(master_doc, 'monascaclientreleasenotes',
|
|
u'Monasca Client Release Notes', [author],
|
|
1)
|
|
]
|
|
|
|
# -- Options for Internationalization output ------------------------------
|
|
locale_dirs = ['locale/']
|