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: Idbe930500bc7988d7e1d78cff3f39beae775db89
This commit is contained in:
parent
cd4c965aac
commit
16a734a0ea
@ -40,8 +40,9 @@ master_doc = 'index'
|
|||||||
copyright = u'2017, OpenStack Developers'
|
copyright = u'2017, OpenStack Developers'
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/ironic-python-agent-builder'
|
openstackdocs_repo_name = 'openstack/ironic-python-agent-builder'
|
||||||
use_storyboard = True
|
openstackdocs_pdf_link = True
|
||||||
|
openstackdocs_use_storyboard = True
|
||||||
|
|
||||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||||
add_function_parentheses = True
|
add_function_parentheses = True
|
||||||
@ -51,7 +52,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 --------------------------------------------------
|
||||||
|
|
||||||
|
@ -56,9 +56,9 @@ project = u'Ironic Python Agent Builder Release Notes'
|
|||||||
copyright = u'2017, OpenStack Developers'
|
copyright = u'2017, OpenStack Developers'
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/ironic-python-agent-builder'
|
openstackdocs_repo_name = 'openstack/ironic-python-agent-builder'
|
||||||
bug_project = 'ironic-python-agent'
|
openstackdocs_auto_name = False
|
||||||
bug_tag = ''
|
openstackdocs_use_storyboard = True
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
@ -100,7 +100,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 = []
|
||||||
|
@ -7,7 +7,7 @@ hacking>=3.0,<3.1.0 # Apache-2.0
|
|||||||
flake8-import-order>=0.17.1 # LGPLv3
|
flake8-import-order>=0.17.1 # LGPLv3
|
||||||
# documentation
|
# documentation
|
||||||
doc8>=0.6.0 # Apache-2.0
|
doc8>=0.6.0 # Apache-2.0
|
||||||
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
|
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||||
openstackdocstheme>=1.31.2 # Apache-2.0
|
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||||
# releasenotes
|
# releasenotes
|
||||||
reno>=2.5.0 # Apache-2.0
|
reno>=3.1.0 # Apache-2.0
|
||||||
|
Loading…
Reference in New Issue
Block a user