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: Ie6fb83cee167bc7f9181f0ade2da825179c1991b
This commit is contained in:
Andreas Jaeger 2020-05-31 20:33:08 +02:00
parent 315e39f18d
commit 1f9202fe72
2 changed files with 6 additions and 5 deletions

View File

@ -3,5 +3,5 @@
# process, which may cause wedges in the gate later.
# this is required for the docs
sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD
openstackdocstheme>=1.23.2 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0

View File

@ -27,8 +27,9 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/openstackclient'
use_storyboard = True
openstackdocs_repo_name = 'openstack/openstackclient'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
html_theme = 'openstackdocs'
# Add any paths that contain templates here, relative to this directory.
@ -77,7 +78,7 @@ exclude_patterns = ['**tests**']
#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 = ['openstackclient.']