openstack
/
freezer-tempest-plugin
Code Issues Proposed changes

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.

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: Ia7f902cce276b8e9bbc62a6f75e123521e471289
This commit is contained in:
Andreas Jaeger 2020-05-30 16:49:10 +02:00
parent 3afe535402
commit e4b0b9377e
3 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt
View File

@ -1,5 +1,5 @@
sphinx>=2.0.0,!=2.1.0 # BSD
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

9
doc/source/conf.py
View File

@ -27,9 +27,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/freezer-tempest-plugin'
bug_project = 'freezer'
bug_tag = ''
openstackdocs_repo_name = 'openstack/freezer-tempest-plugin'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'freezer'
openstackdocs_bug_tag = ''
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
@ -53,7 +54,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 --------------------------------------------------

9
releasenotes/source/conf.py
View File

@ -59,9 +59,10 @@ project = u'freezer Release Notes'
copyright = u'2016, OpenStack Foundation'
# openstackdocstheme options
repository_name = 'openstack/freezer-tempest-plugin'
bug_project = 'freezer'
bug_tag = ''
openstackdocs_repo_name = 'openstack/freezer-tempest-plugin'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'freezer'
openstackdocs_bug_tag = ''
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@ -103,7 +104,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 = []