Browse Source

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: I2dea97815d5f4cd40d120256e91787e078a9cc40
changes/26/732026/1
Andreas Jaeger 12 months ago
parent
commit
863763f8cb
2 changed files with 12 additions and 5 deletions
  1. +11
    -4
      doc/source/conf.py
  2. +1
    -1
      requirements.txt

+ 11
- 4
doc/source/conf.py View File

@ -25,9 +25,10 @@ extensions = [
]
# config for openstackdocstheme
repository_name = 'openstack/masakari-specs'
bug_project = 'masakari-specs'
bug_tag = ''
openstackdocs_repo_name = 'openstack/masakari-specs'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'masakari-specs'
openstackdocs_bug_tag = ''
exclude_patterns = [
'template.rst',
@ -41,6 +42,7 @@ try:
except ImportError:
pass
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
@ -63,7 +65,12 @@ add_function_parentheses = True
add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# -- yasfb configuration ------------------------------------------------------
feed_base_url = 'https://specs.openstack.org/openstack/masakari-specs'
feed_author = 'OpenStack Masakari Team'
# -- Options for HTML output --------------------------------------------------


+ 1
- 1
requirements.txt View File

@ -1,4 +1,4 @@
pbr>=2.0.0,!=2.1.0 # Apache-2.0
openstackdocstheme>=2.0.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
yasfb>=0.5.1

Loading…
Cancel
Save