Switch to newer openstackdocstheme version

Switch to openstackdocstheme 2.2.1 version. Using
this version 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: I0d5889f8f4a846e06c1fdcb69c603c6a4c0b8ba0
This commit is contained in:
Andreas Jaeger 2020-06-02 14:20:42 +02:00
parent 75555eaa3b
commit be7dc8aa49
2 changed files with 8 additions and 4 deletions

View File

@ -36,7 +36,7 @@ extensions = [
]
# Feed configuration for yasfb
feed_base_url = 'http://specs.openstack.org/openstack/qa-specs'
feed_base_url = 'https://specs.openstack.org/openstack/qa-specs'
feed_author = 'OpenStack QA Team'
# Optionally allow the use of sphinxcontrib.spelling to verify the
@ -65,6 +65,10 @@ master_doc = 'index'
project = u'QA Specs'
copyright = u'%s, OpenStack QA Team' % datetime.date.today().year
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/qa-specs'
openstackdocs_auto_name = False
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
@ -97,7 +101,7 @@ add_module_names = False
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 = ['qa-specs.']

View File

@ -1,5 +1,5 @@
pbr>=1.6 # Apache-2.0
docutils>=0.11,!=0.13.1 # OSI-Approved Open Source, Public Domain
sphinx>=1.6.2 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
yasfb>=0.5.1
openstackdocstheme>=1.31.2 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0