openstack/kuryr-tempest-plugin
Code Issues Proposed changes

Switch to newer openstackdocstheme version

Browse Source 
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

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: Ib10098b79479aec37d7b34818dcae9deb3bc1742
This commit is contained in:
Andreas Jaeger 2020-05-30 18:42:19 +02:00
parent c281c48a53
commit 0b0dd66b2c
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt
View File

@ -2,5 +2,5 @@
# of appearance. Changing the order has an impact on the overall integration # of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0

9
doc/source/conf.py
View File

@ -42,9 +42,10 @@ project = u'kuryr'
copyright = u'2017, OpenStack Foundation' copyright = u'2017, OpenStack Foundation'
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/kuryr-tempest-plugin' openstackdocs_repo_name = 'openstack/kuryr-tempest-plugin'
bug_project = 'kuryr-kubernetes' openstackdocs_auto_name = False
bug_tag = '' openstackdocs_bug_project = 'kuryr-kubernetes'
openstackdocs_bug_tag = ''
# 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
@ -54,7 +55,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 --------------------------------------------------