openstack/oslo.privsep
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: I5511824a7ebba08c330efaf5118f130630aa52ae
This commit is contained in:
Andreas Jaeger
2020-05-16 09:43:30 +02:00
parent 5f04cd8dd6
commit c9cc428182
4 changed files with 9 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@@ -2,7 +2,7 @@
# 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
sphinxcontrib-apidoc>=0.2.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD

7
doc/source/conf.py
View File

@@ -23,9 +23,9 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/oslo.privsep' openstackdocs_repo_name = 'openstack/oslo.privsep'
bug_project = 'oslo.privsep' openstackdocs_bug_project = 'oslo.privsep'
bug_tag = '' openstackdocs_bug_tag = ''
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.rst'
@@ -34,7 +34,6 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'oslo.privsep'
copyright = u'2014, OpenStack Foundation' copyright = u'2014, OpenStack Foundation'
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.

4
lower-constraints.txt
View File

@@ -23,7 +23,6 @@ mox3==0.20.0
msgpack==0.6.0 msgpack==0.6.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.config==5.2.0 oslo.config==5.2.0
oslo.context==2.19.2 oslo.context==2.19.2
@@ -42,15 +41,12 @@ python-mimeparse==1.6.0
python-subunit==1.0.0 python-subunit==1.0.0
pytz==2013.6 pytz==2013.6
PyYAML==3.13 PyYAML==3.13
reno==2.5.0
requests==2.14.2 requests==2.14.2
requestsexceptions==1.2.0 requestsexceptions==1.2.0
rfc3986==0.3.1 rfc3986==0.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
stestr==2.0.0 stestr==2.0.0
stevedore==1.20.0 stevedore==1.20.0
testtools==2.2.0 testtools==2.2.0

6
releasenotes/source/conf.py
View File

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