From 759e615074c83c16bf19e9869c9051333f72fa23 Mon Sep 17 00:00:00 2001 From: Hanxi Liu Date: Fri, 23 Jun 2017 11:11:28 +0800 Subject: [PATCH] Docs: switch to openstackdocstheme Project documents are being reprocessed due to document migration[1]. Update the docs theme to openstackdocstheme instead of oslosphinx. [1] https://review.openstack.org/#/c/472275/ Change-Id: Ibbe2dd228aa7c99ba909ab2ee9168e21747f4fe6 --- doc/source/conf.py | 11 ++++++++++- releasenotes/source/conf.py | 12 +++++++++--- setup.cfg | 4 ++-- 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index ec7303f..9486ead 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -62,9 +62,9 @@ gen_ref("v2", "Version 2 API", ["client"]) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ + 'openstackdocstheme', 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -98,6 +98,15 @@ pygments_style = 'sphinx' # html_theme_path = ["."] # html_theme = '_theme' # html_static_path = ['static'] +html_theme = 'openstackdocs' + +# openstackdocstheme options +repository_name = 'openstack/python-pankoclient' +bug_project = 'python-pankoclient' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index b935088..b3813ca 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -41,7 +41,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -114,7 +114,12 @@ 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' + +# openstackdocstheme options +repository_name = 'openstack/python-pankoclient' +bug_project = 'python-pankoclient' +bug_tag = '' # 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 @@ -152,7 +157,8 @@ html_static_path = ['_static'] # 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' +# Must set this variable to include 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/setup.cfg b/setup.cfg index 0dbdec2..b2bb66f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -38,8 +38,8 @@ test = testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD doc = - sphinx!=1.3b1,!=1.6.1,>=1.2.1 # BSD - oslosphinx>=4.7.0 # Apache-2.0 + sphinx>=1.6.2 # BSD + openstackdocstheme>=1.11.0 # Apache-2.0 [entry_points] console_scripts =