diff --git a/doc/source/conf.py b/doc/source/conf.py index 41dbd53..0dd73e2 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,6 +23,9 @@ # serve to show the default. import pbr.version +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 @@ -39,7 +42,8 @@ import pbr.version # ones. extensions = [ 'sphinx.ext.autodoc', - 'oslosphinx' + 'oslosphinx', + 'sphinxmark' ] # Add any paths that contain templates here, relative to this directory. @@ -129,7 +133,7 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # 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 # further. For a list of options available for each theme, see the @@ -137,7 +141,7 @@ todo_include_todos = False # html_theme_options = {} # 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 # " v documentation". @@ -303,3 +307,17 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False + + +watermark = os.popen("git branch --contains $(git rev-parse HEAD)\ +| awk -F/ '/stable/ {print $2}'").read().strip(' \n\t').capitalize() +if watermark == "": + watermark = "Pre-release" + +# -- Options for sphinxmark ----------------------------------------------- +sphinxmark_enable = True +sphinxmark_div = 'docs-body' +sphinxmark_image = 'text' +sphinxmark_text = watermark +sphinxmark_text_color = (128, 128, 128) +sphinxmark_text_size = 70 diff --git a/test-requirements.txt b/test-requirements.txt index 672f615..1bc1c5a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,6 +10,8 @@ ndg-httpsclient>=0.4.2;python_version<'3.0' # BSD # this is required for the docs build jobs sphinx!=1.3b1,<1.4,>=1.2.1 # BSD +openstackdocstheme>=1.5.0 # Apache-2.0 oslosphinx>=4.7.0 # Apache-2.0 doc8 # Apache-2.0 reno>=1.8.0 # Apache2 +sphinxmark>=0.1.14 # Apache-2.0