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_version to not auto-version the documents.

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: Ie22a24f1465420898c0a20efb2773cce2ed6e039
This commit is contained in:
Andreas Jaeger 2020-06-01 15:35:24 +02:00
parent 869f4ca522
commit 1d750e57f0
2 changed files with 9 additions and 4 deletions

View File

@ -50,6 +50,12 @@ master_doc = 'index'
project = u'Performance Docs'
copyright = u'2015, OpenStack Foundation'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/performance-docs'
openstackdocs_bug_project = 'rally'
openstackdocs_bug_tag = 'performance-docs'
openstackdocs_auto_version = False
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
@ -89,7 +95,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 = []

View File

@ -1,6 +1,5 @@
openstackdocstheme>=1.11.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,!=1.6.7;python_version>='3.4' # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
six>=1.9.0
sphinxcontrib-httpdomain
sphinx_rtd_theme