Use openstackdocstheme

Since refstack is an official OpenStack project that gets published on
docs.openstack.org, it should use OpenStack branding.

Use openstackdocstheme and set it up correctly.

Change-Id: Iefce329a5ce85b90528045004356b065101b606b
This commit is contained in:
Andreas Jaeger 2017-04-05 13:30:49 +02:00
parent 1618874428
commit 0d29e9a144
2 changed files with 22 additions and 1 deletions

View File

@ -14,6 +14,7 @@
import sys
import os
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
@ -55,6 +56,20 @@ version = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# 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.
# pwd: source tree - this is needed only for openstackdocstheme <= 1.2.2
# These variables are passed to the logabug code via html_context.
bug_tag = 'refstack'
giturl = u'https://git.openstack.org/cgit/openstack/refstack/tree/doc/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl,
"bug_project": "refstack"}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
@ -98,7 +113,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'nature'
html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@ -107,6 +122,7 @@ html_theme = 'nature'
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
@ -137,6 +153,10 @@ html_theme = 'nature'
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# So that we can enable "log-a-bug" links from each output HTML page, this
# variable must be set to a format that includes year, month, day, hours and
# minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.

View File

@ -12,3 +12,4 @@ testrepository>=0.0.18
testtools>=0.9.34
pep257>=0.5.0
PyMySQL>=0.6.2,!=0.6.4
openstackdocstheme>=1.5.0 # Apache-2.0