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: If08d763c2c0f09faa61c327ab64f1ad7b1549262
This commit is contained in:
Andreas Jaeger 2020-05-30 16:56:24 +02:00
parent c73bc4a2ec
commit 2d2d7baf03
2 changed files with 7 additions and 6 deletions

View File

@ -40,9 +40,10 @@ extensions = [
] ]
# config for openstackdocstheme # config for openstackdocstheme
repository_name = 'openstack/glance-specs' openstackdocs_repo_name = 'openstack/glance-specs'
bug_project = 'glance' openstackdocs_auto_name = False
bug_tag = 'glance-specs' openstackdocs_bug_project = 'glance'
openstackdocs_bug_tag = 'glance-specs'
# Feed configuration for yasfb # Feed configuration for yasfb
feed_base_url = 'http://specs.openstack.org/openstack/glance-specs' feed_base_url = 'http://specs.openstack.org/openstack/glance-specs'
@ -99,7 +100,7 @@ add_module_names = False
show_authors = False show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # 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. # A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['glance-specs.'] modindex_common_prefix = ['glance-specs.']

View File

@ -1,10 +1,10 @@
actdiag actdiag
blockdiag blockdiag
nwdiag nwdiag
openstackdocstheme>=1.32.0 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
pbr>=2.0 # Apache-2.0 pbr>=2.0 # Apache-2.0
seqdiag seqdiag
sphinx>=1.6.2 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-actdiag sphinxcontrib-actdiag
sphinxcontrib-blockdiag sphinxcontrib-blockdiag
sphinxcontrib-nwdiag sphinxcontrib-nwdiag