From 1026425658737aa7f5236f91f9261b6abfa34544 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 3 Jun 2020 17:25:46 +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: Icbb8dcf2364b1b64cec05a0ba31a88f971df19bc --- doc/source/conf.py | 6 +++--- releasenotes/source/conf.py | 15 +++------------ 2 files changed, 6 insertions(+), 15 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 4e11802..03f7e00 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -65,9 +65,9 @@ target_name = 'openstack-ansible-' + role_name title = 'OpenStack-Ansible Documentation: ' + role_name + 'role' # openstackdocstheme options -repository_name = 'openstack/' + target_name -bug_project = project.lower() -bug_tag = '' +openstackdocs_repo_name = 'openstack/' + target_name +openstackdocs_bug_project = project.lower() +openstackdocs_bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 3f6e94b..a282f5b 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -62,11 +62,6 @@ role_name = 'apt_package_pinning' 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 versions. # The full version, including alpha/beta/rc tags. @@ -75,9 +70,9 @@ release = '' version = '' # openstackdocstheme options -repository_name = 'openstack/' + target_name -bug_project = project.lower() -bug_tag = '' +openstackdocs_repo_name = 'openstack/' + target_name +openstackdocs_bug_project = project.lower() +openstackdocs_bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -158,10 +153,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 = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True