From 8bef046f522cee9379c5cb55cc39a0ec5fa8a94f Mon Sep 17 00:00:00 2001 From: Van Hung Pham Date: Mon, 3 Jul 2017 13:25:17 +0700 Subject: [PATCH] Switch from oslosphinx to openstackdocstheme As part of the docs migration work[0] for Pike we need to switch to use the openstackdocstheme. [0]https://review.openstack.org/#/c/472275/ Change-Id: I992266ecc3172e5b40be4e7075eb493a68af0d80 --- doc/source/conf.py | 10 ++++++++-- releasenotes/source/conf.py | 9 +++++++-- test-requirements.txt | 4 ++-- 3 files changed, 17 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index a211c94..a98caca 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -32,7 +32,7 @@ import sys extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', - 'oslosphinx', + 'openstackdocstheme', ] # Add any paths that contain templates here, relative to this directory. @@ -104,7 +104,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 = '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 @@ -143,6 +143,7 @@ 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' +html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -278,3 +279,8 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/cloudkitty-dashboard' +bug_project = 'cloudkitty-dashboard' +bug_tag = 'doc' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 27c9c79..664a8a1 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -26,7 +26,7 @@ import pbr.version # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -100,7 +100,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 @@ -139,6 +139,7 @@ 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' +html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -261,3 +262,7 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/cloudkitty-dashboard' +bug_project = 'cloudkitty-dashboard' +bug_tag = 'doc' diff --git a/test-requirements.txt b/test-requirements.txt index c3dd1eb..2fe8929 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,8 +6,8 @@ hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0 coverage>=3.6 discover python-subunit>=0.0.18 -sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 -oslosphinx>=2.5.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.11.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 testscenarios>=0.4