diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-05-18 21:45:15 +0200 |
|---|---|---|
| committer | Andreas Jaeger <jaegerandi@gmail.com> | 2020-05-22 17:20:37 +0000 |
| commit | 3fa304428c8837174d045bb271a397346e66a3d8 (patch) | |
| tree | 63e164b71008b8d803ad315afdeaf26620aa2db3 /releasenotes | |
| parent | c588de46247a12606c775ee9942ff793d06e96af (diff) | |
| download | python-heatclient-3fa304428c8837174d045bb271a397346e66a3d8.tar.gz | |
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.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
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.
Set openstackdocs_auto_name to use 'project' 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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I5598eebe898555869cd65a74950fdbd76a7baa46
Diffstat (limited to 'releasenotes')
| -rw-r--r-- | releasenotes/source/conf.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 63545a1..ae00ab8 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -47,9 +47,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/python-heatclient' -bug_project = 'heat' -bug_tag = '' +openstackdocs_repo_name = 'openstack/python-heatclient' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -91,7 +91,7 @@ language = None exclude_patterns = [] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -103,7 +103,6 @@ todo_include_todos = False # a list of builtin themes. html_theme = 'openstackdocs' -html_last_updated_fmt = '%Y-%m-%d %H:%M' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. |