diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-05-18 22:08:18 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2020-05-18 22:09:17 +0200 |
| commit | 85ef7b7108ffe491749b52f9ffccade1e2a66164 (patch) | |
| tree | 99d056ceb60266b23c8b7575d29cd3c49a1124ca /releasenotes | |
| parent | 6d9d2e62915edcf6a5796984012ce17e1d87f1c5 (diff) | |
| download | python-neutronclient-85ef7b7108ffe491749b52f9ffccade1e2a66164.tar.gz | |
Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 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_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Set openstackdocs_auto_name to use 'project' as name.
Depends-On: https://review.opendev.org/728938
Change-Id: I9e1dcc5c8861ac9d800ed7425b3e3193dd13c546
Diffstat (limited to 'releasenotes')
| -rw-r--r-- | releasenotes/source/conf.py | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index f7ec392..5b075fe 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -43,9 +43,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/python-neutronclient' -bug_project = 'python-neutronclient' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/python-neutronclient' +openstackdocs_bug_project = 'python-neutronclient' +openstackdocs_bug_tag = 'doc' +openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -148,10 +149,6 @@ html_static_path = ['_static'] # directly to the root of the documentation. # html_extra_path = [] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True |