From d2fef4b60b3a26c354af03dc6480e746cd00d127 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger <aj@suse.com> Date: Sun, 31 May 2020 19:47:24 +0200 Subject: [PATCH] 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. 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: I002235658290ffd494f4507dc0a6c78f94794b19 --- lower-constraints.txt | 6 +++--- releasenotes/source/conf.py | 7 +++---- test-requirements.txt | 6 +++--- 3 files changed, 9 insertions(+), 10 deletions(-) diff --git a/lower-constraints.txt b/lower-constraints.txt index a32a60e0..2c7d1786 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -26,7 +26,7 @@ mox3==0.20.0 msgpack-python==0.4.0 netaddr==0.7.18 netifaces==0.10.4 -openstackdocstheme==1.20.0 +openstackdocstheme==2.2.1 os-client-config==1.28.0 os-testr==1.0.0 oslo.config==5.2.0 @@ -46,14 +46,14 @@ python-mimeparse==1.6.0 python-subunit==1.0.0 pytz==2013.6 PyYAML==3.12 -reno==2.5.0 +reno==3.1.0 requests==2.14.2 requestsexceptions==1.2.0 rfc3986==0.3.1 simplejson==3.8.1 six==1.10.0 smmap==0.9.0 -Sphinx===1.6.2 +Sphinx==2.0.0 stestr==1.0.0 stevedore==1.20.0 tabulate==0.8.1 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index c63e4858..8b8abccb 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -37,14 +37,13 @@ source_encoding = 'utf-8' master_doc = 'index' # General information about the project. -repository_name = u'openstack/monasca-persister' +openstackdocs_repo_name = u'openstack/monasca-persister' # Release notes do not need a version number in the title, they # cover multiple releases. version = '' release = '' -bug_project = u'863' -bug_tag = u'' +openstackdocs_use_storyboard = True copyright = u'2014-present, OpenStack Foundation' author = u'OpenStack Foundation' @@ -78,7 +77,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 = [] diff --git a/test-requirements.txt b/test-requirements.txt index 1e9a4728..237e3b16 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -12,6 +12,6 @@ pycodestyle>=2.5.0 # MIT cassandra-driver>=3.11.0 # release notes -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD -reno>=2.5.0 # Apache-2.0 -openstackdocstheme>=1.20.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +reno>=3.1.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0