Switch to newer openstackdocstheme and reno versions
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: Iec8ad8f132aa68ef8778b6a94266897956f74bd8
This commit is contained in:
parent
4df70061eb
commit
2f59a4b632
@ -1,8 +1,8 @@
|
|||||||
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
|
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||||
openstackdocstheme>=1.20.0 # Apache-2.0
|
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||||
sphinxcontrib-apidoc>=0.2.1 # BSD
|
sphinxcontrib-apidoc>=0.2.1 # BSD
|
||||||
# releasenotes
|
# releasenotes
|
||||||
reno>=2.5.0 # Apache-2.0
|
reno>=3.1.0 # Apache-2.0
|
||||||
|
|
||||||
# PDF Docs
|
# PDF Docs
|
||||||
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
|
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
|
||||||
|
@ -41,19 +41,10 @@ master_doc = 'index'
|
|||||||
# General information about the project.
|
# General information about the project.
|
||||||
copyright = u'2018-2019, OpenStack Octavia Team'
|
copyright = u'2018-2019, OpenStack Octavia Team'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
|
||||||
# |version| and |release|, also used in various other places throughout the
|
|
||||||
# built documents.
|
|
||||||
#
|
|
||||||
# Version info
|
|
||||||
from octavia_lib.version import version_info as octavia_lib_version
|
|
||||||
release = octavia_lib_version.release_string()
|
|
||||||
# The short X.Y version.
|
|
||||||
version = octavia_lib_version.version_string()
|
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/octavia-lib'
|
openstackdocs_repo_name = 'openstack/octavia-lib'
|
||||||
use_storyboard = True
|
openstackdocs_pdf_link = True
|
||||||
|
openstackdocs_use_storyboard = True
|
||||||
|
|
||||||
apidoc_output_dir = 'reference/modules'
|
apidoc_output_dir = 'reference/modules'
|
||||||
apidoc_module_dir = '../../octavia_lib'
|
apidoc_module_dir = '../../octavia_lib'
|
||||||
@ -72,7 +63,7 @@ add_function_parentheses = True
|
|||||||
add_module_names = True
|
add_module_names = True
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'native'
|
||||||
|
|
||||||
# -- Options for HTML output --------------------------------------------------
|
# -- Options for HTML output --------------------------------------------------
|
||||||
|
|
||||||
|
@ -55,8 +55,8 @@ master_doc = 'index'
|
|||||||
copyright = u'2017, OpenStack Developers'
|
copyright = u'2017, OpenStack Developers'
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/octavia-lib'
|
openstackdocs_repo_name = 'openstack/octavia-lib'
|
||||||
use_storyboard = True
|
openstackdocs_use_storyboard = True
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
@ -88,7 +88,7 @@ exclude_patterns = []
|
|||||||
# show_authors = False
|
# show_authors = False
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'native'
|
||||||
|
|
||||||
# A list of ignored prefixes for module index sorting.
|
# A list of ignored prefixes for module index sorting.
|
||||||
# modindex_common_prefix = []
|
# modindex_common_prefix = []
|
||||||
|
Loading…
Reference in New Issue
Block a user