From e544677d396cd965f332de16e9997d0fdcac151a Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 30 May 2020 18:41:15 +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. 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: If74b848e1f63a0e116737553fec8ab76d63457f5 --- doc/source/conf.py | 8 ++++---- lower-constraints.txt | 6 +++--- releasenotes/source/conf.py | 8 ++++---- test-requirements.txt | 6 +++--- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 42f259e3..d73a7533 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -41,10 +41,10 @@ project = u'kuryr-libnetwork' copyright = u'2013, OpenStack Foundation' # openstackdocstheme options -repository_name = 'openstack/kuryr-libnetwork' -bug_project = 'kuryr-libnetwork' -bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/kuryr-libnetwork' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'kuryr-libnetwork' +openstackdocs_bug_tag = '' # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True diff --git a/lower-constraints.txt b/lower-constraints.txt index b5b249ac..b48f2f3f 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -53,7 +53,7 @@ munch==2.2.0 netaddr==0.7.19 netifaces==0.10.6 neutron-lib==1.13.0 -openstackdocstheme==1.18.1 +openstackdocstheme==2.2.1 openstacksdk==0.12.0 os-client-config==1.28.0 os-service-types==1.2.0 @@ -93,7 +93,7 @@ python-neutronclient==6.7.0 python-subunit==1.0.0 pytz==2018.3 PyYAML==3.12 -reno==2.5.0 +reno==3.1.0 repoze.lru==0.7 requests==2.18.4 requestsexceptions==1.4.0 @@ -102,7 +102,7 @@ Routes==2.4.1 simplejson==3.13.2 six==1.10.0 snowballstemmer==1.2.1 -Sphinx==1.6.2 +Sphinx==2.0.0 sphinxcontrib-websupport==1.0.1 SQLAlchemy==1.2.5 sqlalchemy-migrate==0.11.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 4d9373ce..591d242f 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -53,10 +53,10 @@ copyright = u'2017, Kuryr-Libnetwork Developers' author = u'Kuryr-Libnetwork Developers' # openstackdocstheme options -repository_name = 'openstack/kuryr-libnetwork' -bug_project = 'kuryr-libnetwork' -bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/kuryr-libnetwork' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'kuryr-libnetwork' +openstackdocs_bug_tag = '' # Release notes do not need a version number in the title, they # cover multiple releases. diff --git a/test-requirements.txt b/test-requirements.txt index 2f2c3e74..f78c3b06 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,10 +9,10 @@ ddt>=1.0.1 # MIT docker>=2.4.2 # Apache-2.0 stestr>=1.0.0 # Apache-2.0 oslo.serialization!=2.19.1,>=2.18.0 # Apache-2.0 -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD -reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +reno>=3.1.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT