openstack/tripleo-puppet-elements
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
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.

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: I29bd46cb0d134f85ab6e8260339a943240a50568
This commit is contained in:
Andreas Jaeger 2020-06-03 20:38:49 +02:00
parent 4c69eadf85
commit cc4338c747
3 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/conf.py
View File

@ -63,7 +63,7 @@ exclude_patterns = ['_build']
# show_authors = False
# 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.
# modindex_common_prefix = []
@ -228,6 +228,6 @@ texinfo_documents = [
# texinfo_no_detailmenu = False
# openstackdocstheme options
repository_name = 'openstack/tripleo-puppet-elements'
bug_project = 'tripleo'
bug_tag = 'documentation'
openstackdocs_repo_name = 'openstack/tripleo-puppet-elements'
openstackdocs_bug_project = 'tripleo'
openstackdocs_bug_tag = 'documentation'

8
releasenotes/source/conf.py
View File

@ -88,7 +88,7 @@ exclude_patterns = []
#show_authors = False
# 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.
#modindex_common_prefix = []
@ -254,6 +254,6 @@ texinfo_documents = [
locale_dirs = ['locale/']
# openstackdocstheme options
repository_name = 'openstack/tripleo-puppet-elements'
bug_project = 'tripleo'
bug_tag = 'documentation'
openstackdocs_repo_name = 'openstack/tripleo-puppet-elements'
openstackdocs_bug_project = 'tripleo'
openstackdocs_bug_tag = 'documentation'

4
test-requirements.txt
View File

@ -6,8 +6,8 @@ hacking>=3.0.1,<3.1.0 # Apache-2.0
oslotest
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
testrepository>=0.0.18
# This is required for the releasenotes build jobs
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0