From 6553789b8f13217baa189d9f0b847e3381c4901c Mon Sep 17 00:00:00 2001 From: Luz Cazares Date: Tue, 20 Jun 2017 17:28:55 +0000 Subject: [PATCH] Use the openstack theme for documentation Using sphinx openstack theme on refstack-client to be consistent with OpenStack branding Change-Id: I43c727ce8b47b30e4c30b1ddcebede09f064b155 --- doc/source/conf.py | 17 ++++++++++++++--- test-requirements.txt | 3 ++- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 1d91137..f4d83b3 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -28,7 +28,14 @@ import os # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = [ + 'openstackdocstheme' +] + +# openstackdocstheme options +repository_name = 'openstack/refstack-client' +bug_project = '879' +bug_tag = '' # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -98,7 +105,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 = 'default' +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 @@ -106,7 +113,7 @@ html_theme = 'default' #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -137,6 +144,10 @@ html_theme = 'default' # 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. diff --git a/test-requirements.txt b/test-requirements.txt index c9f3cff..0ad075c 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,9 +3,10 @@ pyflakes>=0.7.2,<0.7.4 flake8==2.0 docutils>=0.11 # OSI-Approved Open Source, Public Domain # required to build documentation -sphinx>=1.5.1 +sphinx>=1.6.2 # BSD testrepository>=0.0.18 testtools>=0.9.34 mock coverage httmock +openstackdocstheme>=1.11.0 # Apache-2.0