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: Icc4368708d2f1a11cb976789d8e06496b231302e
This commit is contained in:
Andreas Jaeger 2020-05-30 16:48:16 +02:00
parent d635d016c1
commit d9c1dc80ae
2 changed files with 6 additions and 5 deletions

View File

@ -1,6 +1,6 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.32.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
yasfb>=0.5.1

View File

@ -58,8 +58,9 @@ project = u'Freezer Specs'
copyright = u'%s, OpenStack Freezer Team' % datetime.date.today().year
# openstackdocstheme options
repository_name = 'openstack/freezer-specs'
use_storyboard = True
openstackdocs_repo_name = 'openstack/freezer-specs'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
html_theme = 'openstackdocs'
# The language for content autogenerated by Sphinx. Refer to documentation
@ -93,7 +94,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 = ['freezer-specs.']