Browse Source

Switch to newer openstackdocstheme and reno versions

Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

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: I02b83b2d2ffa7e007f8150176ac881a8b6a53495
changes/45/732045/2
Andreas Jaeger 1 year ago
committed by Brian Haley
parent
commit
7dc2857705
  1. 8
      doc/source/conf.py
  2. 8
      releasenotes/source/conf.py
  3. 4
      test-requirements.txt

8
doc/source/conf.py

@ -39,9 +39,9 @@ master_doc = 'index'
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
repository_name = 'openstack/openstack'
bug_project = 'neutron_tempest_plugin'
bug_tag = ''
openstackdocs_repo_name = 'openstack/neutron-tempest-plugin'
openstackdocs_bug_project = 'neutron_tempest_plugin'
openstackdocs_bug_tag = ''
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -51,7 +51,7 @@ add_function_parentheses = True
add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# -- Options for HTML output --------------------------------------------------

8
releasenotes/source/conf.py

@ -55,9 +55,9 @@ master_doc = 'index'
copyright = u'2017, Neutron Tempest Plugin Developers'
# openstackdocstheme options
repository_name = 'openstack/neutron-tempest-plugin'
bug_project = 'neutron'
bug_tag = ''
openstackdocs_repo_name = 'openstack/neutron-tempest-plugin'
openstackdocs_bug_project = 'neutron'
openstackdocs_bug_tag = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -89,7 +89,7 @@ exclude_patterns = []
# 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 = []

4
test-requirements.txt

@ -11,6 +11,6 @@ sphinx>=2.0.0,!=2.1.0 # BSD
oslotest>=3.2.0 # Apache-2.0
stestr>=1.0.0 # Apache-2.0
testtools>=2.2.0 # MIT
openstackdocstheme>=2.0.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
# releasenotes
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
Loading…
Cancel
Save