Fix openstackdocstheme settings

Code Issues Proposed changes

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: Iea2bbb38ca17318c9325433522f5e8b9985d76f6

This commit is contained in:

ZhongShengping

2017年07月03日 16:20:33 +08:00

parent 031b386bdd

commit fe528783f9

3 changed files with 12 additions and 20 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

22
doc/source/conf.py

View File

@@ -22,7 +22,6 @@

# All configuration values have a default; values that are commented out

# serve to show the default.

import openstackdocstheme

import pbr.version

import os

@@ -40,8 +39,8 @@ import os

# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

# ones.

extensions = [

'openstackdocstheme',

'sphinx.ext.autodoc',

'oslosphinx',

'sphinxmark'

]

@@ -83,21 +82,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/doc/source").format(target_name)

git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d''"

gitsha = os.popen(git_cmd).read().strip('\n')

# openstackdocstheme options

repository_name = 'openstack/' + target_name

bug_project = project.lower()

bug_title = "Documentation bug"

html_context = {"gitsha": gitsha, "giturl": giturl,

"bug_tag": "docs", "bug_title": bug_title,

"bug_project": bug_project}

bug_tag = ''

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

@@ -156,7 +144,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

# "<project> v<release> documentation".

Fix openstackdocstheme settings

22 doc/source/conf.py Unescape Escape View File

22
doc/source/conf.py

View File