]> review.fuel-infra Code Review - puppet-modules/puppet-ceilometer.git/commitdiff
Switch to newer openstackdocstheme and reno versions
authorAndreas Jaeger <aj@suse.com>
Tue, 2 Jun 2020 12:32:28 +0000 (14:32 +0200)
committerAndreas Jaeger <aj@suse.com>
Tue, 2 Jun 2020 12:33:11 +0000 (14:33 +0200)
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: I160c83cad6391c988b8b36e4bac346f11b8fc8fb

doc/requirements.txt
releasenotes/source/conf.py

index d3373815d6cfeb6968a46d3796a0b50fbd5d5e34..44cb2082b41685958428276fb07a653a55b7139c 100644 (file)
@@ -1,6 +1,6 @@
 # This is required for the docs build jobs
-sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
-openstackdocstheme>=1.30.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
 
 # This is required for the releasenotes build jobs
-reno>=2.5.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
index 39ecbcf0304d244e27a60fd57533faba1b41b34f..9d5fffa354f60e33e5da70c6b7cb950e009c3ec9 100644 (file)
@@ -86,7 +86,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 = []
@@ -250,6 +250,6 @@ texinfo_documents = [
 locale_dirs = ['locale/']
 
 # openstackdocstheme options
-repository_name = 'openstack/puppet-ceilometer'
-bug_project = 'puppet-ceilometer'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/puppet-ceilometer'
+openstackdocs_bug_project = 'puppet-ceilometer'
+openstackdocs_bug_tag = ''