openstack/openstack-ansible-galera_server
Code Issues Proposed changes

Merge "[DOCS] Added release-name as a watermark to Docs."

Browse Source
This commit is contained in:
Jenkins
2016-10-20 17:09:37 +00:00
committed by Gerrit Code Review
parent 062566ee15 be26446d99
commit 8e08cd9a42
2 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/conf.py
View File

@@ -22,6 +22,7 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import openstackdocstheme
import pbr.version import pbr.version
import os import os
@@ -131,7 +132,7 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# html_theme = 'alabaster' html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme # 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 # further. For a list of options available for each theme, see the
@@ -139,7 +140,7 @@ todo_include_todos = False
# html_theme_options = {} # html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory. # 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 # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
@@ -306,9 +307,11 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False # texinfo_no_detailmenu = False
watermark = os.popen("git branch --contains $(git rev-parse HEAD) | awk -F/ '/stable/ {print $2}'").read().strip(' \n\t').capitalize()
watermark = os.popen("git branch --contains $(git rev-parse HEAD)\
| awk -F/ '/stable/ {print $2}'").read().strip(' \n\t').capitalize()
if watermark == "": if watermark == "":
watermark = "Pre-release" watermark = "Pre-release"
# -- Options for sphinxmark ----------------------------------------------- # -- Options for sphinxmark -----------------------------------------------
sphinxmark_enable = True sphinxmark_enable = True

1
test-requirements.txt
View File

@@ -11,6 +11,7 @@ ndg-httpsclient>=0.4.2;python_version<'3.0' # BSD
# this is required for the docs build jobs # this is required for the docs build jobs
sphinx!=1.3b1,<1.4,>=1.2.1 # BSD sphinx!=1.3b1,<1.4,>=1.2.1 # BSD
oslosphinx>=4.7.0 # Apache-2.0 oslosphinx>=4.7.0 # Apache-2.0
openstackdocstheme>=1.5.0 # Apache-2.0
doc8 # Apache-2.0 doc8 # Apache-2.0
reno>=1.8.0 # Apache2 reno>=1.8.0 # Apache2
sphinxmark>=0.1.14 # Apache-2.0 sphinxmark>=0.1.14 # Apache-2.0