openstack
/
oslo.rootwrap
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions 

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: Ie162c8e72f4edec345c20de4517304cc14f7fe0d
This commit is contained in:
Andreas Jaeger 2020-05-16 09:47:25 +02:00
parent 0e42d495ba
commit 4c0480648d
5 changed files with 11 additions and 14 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
# process, which may cause wedges in the gate later.
# These are needed for docs generation
openstackdocstheme>=1.20.0 # Apache-2.0
sphinx>=1.8.0,!=2.1.0 # BSD
reno>=2.5.0 # Apache-2.0
openstackdocstheme>=2.2.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
reno>=3.1.0 # Apache-2.0
mock>=2.0.0 # BSD
fixtures>=3.0.0 # Apache-2.0/BSD

6
doc/source/conf.py
View File

@ -27,9 +27,9 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/oslo.rootwrap'
bug_project = 'oslo.rootwrap'
bug_tag = ''
openstackdocs_repo_name = 'openstack/oslo.rootwrap'
openstackdocs_bug_project = 'oslo.rootwrap'
openstackdocs_bug_tag = ''
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.

5
lower-constraints.txt
View File

@ -18,7 +18,6 @@ linecache2==1.0.0
MarkupSafe==1.0
mccabe==0.2.1
mox3==0.20.0
openstackdocstheme==1.20.0
os-client-config==1.28.0
oslotest==3.2.0
pbr==2.0.0
@ -27,14 +26,12 @@ 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
six==1.10.0
smmap==0.9.0
snowballstemmer==1.2.1
Sphinx==1.8.0
sphinxcontrib-websupport==1.0.1
stestr==2.0.0
stevedore==1.20.0
testtools==2.2.0

6
releasenotes/source/conf.py
View File

@ -40,9 +40,9 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/oslo.rootwrap'
bug_project = 'oslo.rootwrap'
bug_tag = ''
openstackdocs_repo_name = 'openstack/oslo.rootwrap'
openstackdocs_bug_project = 'oslo.rootwrap'
openstackdocs_bug_tag = ''
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

2
test-requirements.txt
View File

@ -14,7 +14,7 @@ oslotest>=3.2.0 # Apache-2.0
# rootwrap daemon's client should be verified to run in eventlet
eventlet!=0.18.3,!=0.20.1,>=0.18.2 # MIT
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
# Bandit security code scanner
bandit>=1.1.0 # Apache-2.0