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: I611663fd224ddbd8a315732966c60ca67a5ffc40
This commit is contained in:
Andreas Jaeger 2020-06-03 20:45:43 +02:00
parent 2a6832fae6
commit 3d154b5f7a
2 changed files with 7 additions and 3 deletions

View File

@ -66,6 +66,10 @@ master_doc = 'index'
project = u'OpenStack Governance'
copyright = u'2013 OpenStack Technical Committee'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/governance'
openstackdocs_auto_name = False
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
@ -95,7 +99,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 = []

View File

@ -1,7 +1,7 @@
# needed for doc build
docutils>=0.11,!=0.13.1 # OSI-Approved Open Source, Public Domain
openstackdocstheme>=2.0.0 # Apache 2.0
sphinx!=2.1.0,>=2.0
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
PyYAML>=3.1.0
yamllint>=0.5.2
requests-cache