openstack/oslo.messaging
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
Switch to openstackdocstheme 2.2.0 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

Update Sphinx version as well.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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.

Depends-On: https://review.opendev.org/728938
Change-Id: I70c7edf8b95cde890e6263195be1de6bb826e700
This commit is contained in:
Andreas Jaeger 2020-05-16 09:34:40 +02:00
parent e44c988306
commit 9cc3f52ac3
4 changed files with 9 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -2,9 +2,9 @@
# of appearance. Changing the order has an impact on the overall integration # of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
openstackdocstheme>=1.20.0 # Apache-2.0 openstackdocstheme>=2.2.0 # Apache-2.0
sphinx>=1.8.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
# imported when the source code is parsed for generating documentation: # imported when the source code is parsed for generating documentation:
fixtures>=3.0.0 # Apache-2.0/BSD fixtures>=3.0.0 # Apache-2.0/BSD

6
doc/source/conf.py
View File

@ -25,9 +25,9 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/oslo.messaging' openstackdocs_repo_name = 'openstack/oslo.messaging'
bug_project = 'oslo.messaging' openstackdocs_bug_project = 'oslo.messaging'
bug_tag = '' openstackdocs_bug_tag = ''
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'

4
lower-constraints.txt
View File

@ -36,7 +36,6 @@ mox3==0.20.0
msgpack-python==0.4.0 msgpack-python==0.4.0
netaddr==0.7.18 netaddr==0.7.18
netifaces==0.10.4 netifaces==0.10.4
openstackdocstheme==1.20.0
os-client-config==1.28.0 os-client-config==1.28.0
oslo.concurrency==3.25.0 oslo.concurrency==3.25.0
oslo.config==5.2.0 oslo.config==5.2.0
@ -67,7 +66,6 @@ python-qpid-proton==0.17.0
python-subunit==1.0.0 python-subunit==1.0.0
pytz==2013.6 pytz==2013.6
PyYAML==3.12 PyYAML==3.12
reno==2.5.0
repoze.lru==0.7 repoze.lru==0.7
requests==2.14.2 requests==2.14.2
requestsexceptions==1.2.0 requestsexceptions==1.2.0
@ -76,8 +74,6 @@ Routes==2.3.1
six==1.10.0 six==1.10.0
smmap==0.9.0 smmap==0.9.0
snowballstemmer==1.2.1 snowballstemmer==1.2.1
Sphinx==1.8.0
sphinxcontrib-websupport==1.0.1
statsd==3.2.1 statsd==3.2.1
stestr==2.0.0 stestr==2.0.0
stevedore==1.20.0 stevedore==1.20.0

6
releasenotes/source/conf.py
View File

@ -46,9 +46,9 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/oslo.messaging' openstackdocs_repo_name = 'openstack/oslo.messaging'
bug_project = 'oslo.messaging' openstackdocs_bug_project = 'oslo.messaging'
bug_tag = '' openstackdocs_bug_tag = ''
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'