From 9669860c6228965ffc9a3fbcaa18048f717d2ce8 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 3 Jun 2020 18:41:21 +0200 Subject: [PATCH] Use newer openstackdocstheme and reno versions The sync from https://review.opendev.org/733244 updated to openstackdocstheme 2.2.1 and reno 3.1.0 versions. 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. 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: I137842c58acf84c5d8d67d4a1e4a2e8ab073ae19 --- doc/source/conf.py | 7 ++++--- releasenotes/source/conf.py | 11 +++-------- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 59fcece8..0a1ab982 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -65,9 +65,10 @@ target_name = 'openstack-ansible-' + role_name title = 'OpenStack-Ansible Documentation: ' + role_name + ' role' # openstackdocstheme options -repository_name = 'openstack/' + target_name -bug_project = "openstack-ansible" -bug_tag = '' +openstackdocs_repo_name = 'openstack/' + target_name +openstackdocs_pdf_link = True +openstackdocs_bug_project = "openstack-ansible" +openstackdocs_bug_tag = '' # for a list of supported languages. # diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index a1dc8c4b..d5723490 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -61,11 +61,6 @@ role_name = 'os_neutron' target_name = 'openstack-ansible-' + role_name title = 'OpenStack-Ansible Release Notes: ' + role_name + 'role' -# The link to the browsable source code (for the left hand menu) -oslosphinx_cgit_link = ( - 'https://opendev.org/openstack/{}'.format(target_name) -) - # Release notes do not need a version number in the title, they # cover multiple releases. # The full version, including alpha/beta/rc tags. @@ -74,9 +69,9 @@ release = '' version = '' # openstackdocstheme options -repository_name = 'openstack/' + target_name -bug_project = "openstack-ansible" -bug_tag = '' +openstackdocs_repo_name = 'openstack/' + target_name +openstackdocs_bug_project = "openstack-ansible" +openstackdocs_bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.