openstack/kuryr-libnetwork
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: If74b848e1f63a0e116737553fec8ab76d63457f5
This commit is contained in:
Andreas Jaeger 2020-05-30 18:41:15 +02:00
parent 4c445c2198
commit e544677d39
4 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/conf.py
View File

@ -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

6
lower-constraints.txt
View File

@ -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

8
releasenotes/source/conf.py
View File

@ -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.

6
test-requirements.txt
View File

@ -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