From b0ff0fda147728f2bda17e13ee459aabd43c7551 Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Thu, 6 Jul 2017 09:16:15 +0800 Subject: [PATCH] Fix openstackdocstheme settings To use openstackdocstheme 1.11.0 properly, this patch fixes some settings according to follow[0]. [0]https://docs.openstack.org/openstackdocstheme/latest/ Change-Id: Iba47e61ee6c2d326b222ef69e752f8266e014a25 --- deploy-guide/source/conf.py | 27 +++++++++++---------------- releasenotes/source/conf.py | 9 +++++++-- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/deploy-guide/source/conf.py b/deploy-guide/source/conf.py index 3c61e74d4d..035e5986ce 100644 --- a/deploy-guide/source/conf.py +++ b/deploy-guide/source/conf.py @@ -22,7 +22,6 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import openstackdocstheme import os import pbr.version import sys @@ -41,7 +40,12 @@ sys.path.insert(0, os.path.abspath('../../playbooks/inventory/')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. # TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder' -extensions = ['sphinx.ext.autodoc','sphinxmark', 'sphinx.ext.extlinks'] +extensions = [ + 'openstackdocstheme', + 'sphinx.ext.autodoc', + 'sphinxmark', + 'sphinx.ext.extlinks' +] # Add any paths that contain templates here, relative to this directory. #templates_path = ['_templates'] @@ -75,19 +79,10 @@ release = version_info.version_string_with_vcs() # The short X.Y version. version = version_info.canonical_version_string() -# A few variables have to be set for the log-a-bug feature. -# giturl: The location of conf.py on Git. Must be set manually. -# gitsha: The SHA checksum of the bug description. Automatically extracted from git log. -# bug_tag: Tag for categorizing the bug. Must be set manually. -# These variables are passed to the logabug code via html_context. -giturl = ("https://git.openstack.org/cgit/openstack/{0}" - "/tree/deploy-guide/source").format(target_name) -git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" -gitsha = os.popen(git_cmd).read().strip('\n') -bug_title = "Documentation bug" -html_context = {"gitsha": gitsha, "giturl": giturl, - "bug_tag": "docs", "bug_title": bug_title, - "bug_project": target_name} +# openstackdocstheme options +repository_name = 'openstack/' + target_name +bug_project = project.lower() +bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -139,7 +134,7 @@ html_theme = 'openstackdocs' # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [openstackdocstheme.get_html_theme_path()] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 58aed37e9f..b2fbfcc1a4 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -23,7 +23,6 @@ # serve to show the default. import pbr.version -import openstackdocstheme # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -39,6 +38,7 @@ import openstackdocstheme # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'openstackdocstheme', 'reno.sphinxext', ] @@ -77,6 +77,11 @@ release = version_info.version_string_with_vcs() # The short X.Y version. version = version_info.canonical_version_string() +# openstackdocstheme options +repository_name = 'openstack/' + target_name +bug_project = project.lower() +bug_tag = '' + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -128,7 +133,7 @@ html_theme = 'openstackdocs' # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [openstackdocstheme.get_html_theme_path()] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation".