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: I9dbba04f3918ced819e9e69a58bc5e580ad5d538
This commit is contained in:
Andreas Jaeger 2020-05-31 17:47:35 +02:00
parent dbc3dbe5bd
commit eb7c979999
2 changed files with 8 additions and 7 deletions

View File

@ -51,6 +51,11 @@ master_doc = 'index'
project = u'Magnum Specs'
copyright = u'%s, OpenStack Containers Team' % datetime.date.today().year
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/magnum-specs'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
@ -83,7 +88,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 = ['magnum-specs.']
@ -121,10 +126,6 @@ html_theme = 'openstackdocs'
# pixels large.
#html_favicon = None
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

View File

@ -1,4 +1,4 @@
pbr>=0.6,!=0.7,<1.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
openstackdocstheme>=1.20.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
yasfb>=0.5.1