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: Ib928a4799233cf1d85a2b045bd7323c0576c72cb
This commit is contained in:
Andreas Jaeger 2020-06-03 20:47:41 +02:00
parent c9d6891cf9
commit b6859cc4c5
2 changed files with 7 additions and 3 deletions

View File

@ -58,6 +58,10 @@ master_doc = 'index'
project = u'OpenStack SIG Governance'
copyright = u'2017, OpenStack Meta SIG'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/governance-sigs'
openstackdocs_auto_name = False
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
@ -88,7 +92,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

@ -3,6 +3,6 @@
# process, which may cause wedges in the gate later.
# needed for doc build
docutils>=0.11,!=0.13.1 # OSI-Approved Open Source, Public Domain
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
openstackdocstheme>=1.31.2 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
yamllint