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 problems

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.

Set openstackdocs_auto_name to use 'project' as name.

Use releasenotes jobs template instead of individual jobs.

Depends-On: https://review.opendev.org/728938
Change-Id: I2f3f66a19cda62c6d51c764a0d7e2a163d8abe74
This commit is contained in:
Andreas Jaeger 2020-05-18 21:52:20 +02:00
parent 1a1fe76a6a
commit 1c746d8efb
5 changed files with 11 additions and 16 deletions

View File

@ -5,11 +5,8 @@
- openstack-lower-constraints-jobs - openstack-lower-constraints-jobs
- openstack-python3-victoria-jobs - openstack-python3-victoria-jobs
- publish-openstack-docs-pti - publish-openstack-docs-pti
- build-release-notes-jobs-python3
check: check:
jobs: jobs:
- build-openstack-releasenotes
- openstack-tox-cover: - openstack-tox-cover:
voting: false voting: false
gate:
jobs:
- build-openstack-releasenotes

View File

@ -1,3 +1,3 @@
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=1.32.1 # Apache-2.0 openstackdocstheme>=2.2.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0

View File

@ -62,9 +62,9 @@ html_theme = 'openstackdocs'
# html_static_path = ['static'] # html_static_path = ['static']
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/python-magnumclient' openstackdocs_repo_name = 'openstack/python-magnumclient'
bug_project = 'python-magnumclient' openstackdocs_bug_project = 'python-magnumclient'
bug_tag = '' openstackdocs_bug_tag = ''
# Output file base name for HTML help builder. # Output file base name for HTML help builder.

View File

@ -47,7 +47,6 @@ msgpack-python==0.4.0
munch==2.1.0 munch==2.1.0
netaddr==0.7.18 netaddr==0.7.18
netifaces==0.10.4 netifaces==0.10.4
openstackdocstheme==1.32.1
openstacksdk==0.11.2 openstacksdk==0.11.2
os-client-config==1.28.0 os-client-config==1.28.0
os-service-types==1.2.0 os-service-types==1.2.0
@ -97,8 +96,6 @@ Routes==2.3.1
simplejson==3.5.1 simplejson==3.5.1
smmap==0.9.0 smmap==0.9.0
snowballstemmer==1.2.1 snowballstemmer==1.2.1
Sphinx==1.6.5
sphinxcontrib-websupport==1.0.1
statsd==3.2.1 statsd==3.2.1
stevedore==1.20.0 stevedore==1.20.0
tenacity==3.2.1 tenacity==3.2.1

View File

@ -271,6 +271,7 @@ texinfo_documents = [
locale_dirs = ['locale/'] locale_dirs = ['locale/']
# -- Options for openstackdocstheme ------------------------------------------- # -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/python-magnumclient' openstackdocs_repo_name = 'openstack/python-magnumclient'
bug_project = 'python-magnumclient' openstackdocs_bug_project = 'python-magnumclient'
bug_tag = '' openstackdocs_bug_tag = ''
openstackdocs_auto_name = False