From 90eb5626452d46f24f6e539da23971f8698bc2b3 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Evrard Date: Fri, 23 Mar 2018 12:16:07 +0000 Subject: [PATCH] [Docs] Fix docs for latest openstackdocstheme The latest openstackdocs theme is now providing defaults for project name, version. We shouldn't ship this in our code. Change-Id: I7943b5bae40515d260be21edd82284e9638880b0 --- doc/source/conf.py | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 22059c4818..ad186762f9 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -36,15 +36,15 @@ description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.' previous_series_name = 'queens' current_series_name = 'rocky' -# General information about the project. +## General information about the project. author = 'OpenStack-Ansible Contributors' category = 'Miscellaneous' -copyright = '2014-2017, OpenStack-Ansible Contributors' -project = 'OpenStack-Ansible' +copyright = '2014-2018, OpenStack-Ansible Contributors' title = 'OpenStack-Ansible Documentation' -# Smart variable replacements -current_series = openstackdocstheme.get_series_name() +# Smart variable replacements with what we can. The openstackdocstheme has +# no stable interface though. This works with 1.20. +current_series = openstackdocstheme.ext._get_series_name() if current_series == "latest": watermark = "Pre-release" @@ -57,10 +57,6 @@ else: branch = "stable/{}".format(current_series) upgrade_warning = "The upgrade is always under active development." -# Ensure the top left corner of openstack docs theme -# is consistent with latest available tag -version = latest_tag - CONF_PATH = os.path.dirname(os.path.realpath(__file__)) GNOCCHI_DETAILS = '../../playbooks/defaults/repo_packages/gnocchi.yml' with open(os.path.join(CONF_PATH, GNOCCHI_DETAILS), 'r') as fdesc: @@ -140,7 +136,8 @@ master_doc = 'index' # openstackdocstheme options repository_name = 'openstack/' + target_name -bug_project = project.lower() +# The bug project is always the same for all our repos +bug_project = 'openstack-ansible' bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation @@ -334,7 +331,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ (master_doc, target_name, - title, author, project, + title, author, bug_project, description, category), ]