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.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

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.

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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I23798a960616d53d1cc54342640e670fc677738d
This commit is contained in:
Andreas Jaeger 2020-05-21 12:52:28 +02:00
parent 1bffde3315
commit 5b98e12acb
5 changed files with 15 additions and 15 deletions

View File

@ -3,8 +3,8 @@
# process, which may cause wedges in the gate later.
# For generationg sphinx documentation
openstackdocstheme>=2.0.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD

View File

@ -101,7 +101,7 @@ add_module_names = True
#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 = ['keystoneauth1.']
@ -237,6 +237,8 @@ intersphinx_mapping = {
}
# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/keystoneauth'
bug_project = 'keystoneauth'
bug_tag = 'doc'
openstackdocs_repo_name = 'openstack/keystoneauth'
openstackdocs_pdf_link = True
openstackdocs_auto_name = False
openstackdocs_bug_project = 'keystoneauth'
openstackdocs_bug_tag = 'doc'

View File

@ -30,7 +30,6 @@ netaddr==0.7.19
netifaces==0.10.6
oauthlib==0.6.2
openstack-requirements==1.2.0
openstackdocstheme==2.0.0
os-client-config==1.29.0
os-service-types==1.2.0
oslo.config==5.2.0
@ -50,7 +49,7 @@ python-mimeparse==1.6.0
python-subunit==1.2.0
pytz==2018.3
PyYAML==3.12
reno==2.5.0
reno==3.1.0
requests-kerberos==0.8.0
requests-mock==1.2.0
requests==2.14.2
@ -59,8 +58,6 @@ rfc3986==1.1.0
six==1.10.0
smmap2==2.0.3
snowballstemmer==1.2.1
Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1
stestr==1.0.0
stevedore==1.20.0
testrepository==0.0.20

View File

@ -97,7 +97,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 = []
@ -273,6 +273,7 @@ texinfo_documents = [
locale_dirs = ['locale/']
# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/keystoneauth'
bug_project = 'keystoneauth'
bug_tag = 'doc'
openstackdocs_repo_name = 'openstack/keystoneauth'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'keystoneauth'
openstackdocs_bug_tag = 'doc'

View File

@ -14,7 +14,7 @@ oslo.config>=5.2.0 # Apache-2.0
oslo.utils>=3.33.0 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0
betamax>=0.7.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
requests-mock>=1.2.0 # Apache-2.0
stestr>=1.0.0 # Apache-2.0
testresources>=2.0.0 # Apache-2.0/BSD