From 2242cb652e2ce74a852c6cfd677f1cd000a2cae1 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 2 Jun 2020 13:45:55 +0200 Subject: [PATCH] Support newer openstackdocstheme openstackdocstheme 2.2.0 introduces new variables, add them here so that both older and newer openstackdocstheme versions are supported. 2.2.0 suport the old settings but in the future those might get removed, so let's be future-proof. Since this repo is still supporting py27, we need support for older openstackdocstheme versions. Change-Id: I6ee389843d1d959cffb126e0cd56ef6ef1e2f5e1 --- doc/source/conf.py | 9 ++++++++- releasenotes/source/conf.py | 15 +++++++++------ 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 13f63a0b..aa51538f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -17,10 +17,17 @@ except ImportError: openstackdocstheme = None # openstackdocstheme options + +# Deprecated options for docstheme < 2.2.0, can be removed once +# pbr stops supporting py27. repository_name = 'openstack/pbr' bug_project = 'pbr' bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +# New options with openstackdocstheme >=2.2.0 +openstackdocs_repo_name = 'openstack/pbr' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'pbr' +openstackdocs_bug_tag = '' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 56f7ecdb..0c3627cb 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -41,13 +41,16 @@ release = '' # a list of builtin themes. html_theme = 'openstackdocs' -# 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' - - # -- Options for openstackdocstheme --------------------------------------- -repository_name = 'openstack-dev/pbr' +# Deprecated options for openstackdocstheme < 2.2.0, can be removed once +# pbr stops supporting py27. +repository_name = 'openstack/pbr' bug_project = 'pbr' bug_tag = '' + +# New options with openstackdocstheme >=2.2.0 +openstackdocs_repo_name = 'openstack/pbr' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'pbr' +openstackdocs_bug_tag = ''