openstack
/
tripleo-validations
Code Issues Proposed changes

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: Ia2daec6d0819b99ef0ace7dae52f6c8ef0779cca
This commit is contained in:
Andreas Jaeger 2020-06-03 20:43:03 +02:00
parent 2d565ad8ee
commit 467ebf5244
5 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -1,7 +1,7 @@
# this is required for the docs build jobs
sphinx>=1.8.0,!=2.1.0 # BSD
openstackdocstheme>=1.31.2 # Apache-2.0
reno>=2.11.3 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
doc8>=0.8.0 # Apache-2.0
bashate>=0.6.0 # Apache-2.0
six>=1.11.0 # MIT

6
doc/source/conf.py
View File

@ -75,6 +75,6 @@ latex_documents = [
]
# openstackdocstheme options
repository_name = 'openstack/tripleo-validations'
bug_project = 'tripleo'
bug_tag = 'documentation'
openstackdocs_repo_name = 'openstack/tripleo-validations'
openstackdocs_bug_project = 'tripleo'
openstackdocs_bug_tag = 'documentation'

6
lower-constraints.txt
View File

@ -49,7 +49,7 @@ msgpack==0.5.6
munch==2.2.0
netaddr==0.7.18
netifaces==0.10.6
openstackdocstheme==1.31.2
openstackdocstheme==2.2.1
openstacksdk==0.36.0
os-client-config==1.29.0
os-net-config==7.1.0
@ -92,7 +92,7 @@ python-swiftclient==3.5.0
python-zaqarclient==1.9.0
pytz==2018.3
PyYAML==3.12
reno==2.5.0
reno==3.1.0
requests==2.18.4
requestsexceptions==1.4.0
rfc3986==1.1.0
@ -100,7 +100,7 @@ simplejson==3.13.2
six==1.11.0
smmap2==2.0.3
snowballstemmer==1.2.1
Sphinx==1.8.0
Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1
stevedore==1.28.0
tenacity==5.0.1

9
releasenotes/source/conf.py
View File

@ -98,7 +98,7 @@ exclude_patterns = []
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
@ -316,6 +316,7 @@ texinfo_documents = [
locale_dirs = ['locale/']
# openstackdocstheme options
repository_name = 'openstack/tripleo-validations'
bug_project = 'tripleo'
bug_tag = 'documentation'
openstackdocs_repo_name = 'openstack/tripleo-validations'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'tripleo'
openstackdocs_bug_tag = 'documentation'

6
test-requirements.txt
View File

@ -2,16 +2,16 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
openstackdocstheme>=1.31.2 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
hacking>=3.0,<3.1.0 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0
python-subunit>=1.0.0 # Apache-2.0/BSD
sphinx>=1.8.0,!=2.1.0 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
oslotest>=3.2.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD
testtools>=2.2.0 # MIT
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
netaddr>=0.7.18 # BSD
pre-commit # MIT