From 66d45fc53d8773b85eb3239aca53bff01aca939e Mon Sep 17 00:00:00 2001 From: Van Hung Pham Date: Thu, 29 Jun 2017 14:01:36 +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: I7c001fa8f627dc991759e157a802588962af53d9 --- doc/source/conf.py | 10 ++++++---- releasenotes/source/conf.py | 9 +++++---- test-requirements.txt | 3 +-- 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index aa70d6f..a9c5e4b 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,8 +23,6 @@ """Docs config for monitorstck.""" import os -import openstackdocstheme - import pbr.version # If extensions (or modules to document with autodoc) are in another directory, @@ -47,7 +45,7 @@ import pbr.version # ones. extensions = [ 'sphinx.ext.autodoc', - 'oslosphinx', + 'openstackdocstheme', 'sphinxmark' ] @@ -133,8 +131,12 @@ html_theme_options = { } # Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [openstackdocstheme.get_html_theme_path()] +# html_theme_path = ["."] +# 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' # -- Options for HTMLHelp output ------------------------------------------ diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index ff5306a..5b4a8ea 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -23,8 +23,6 @@ """Release notes for monitorstack.""" import os -import openstackdocstheme - import pbr.version # If extensions (or modules to document with autodoc) are in another directory, @@ -46,7 +44,7 @@ import pbr.version # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -131,8 +129,11 @@ html_theme = 'openstackdocs' # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [openstackdocstheme.get_html_theme_path()] +# html_theme_path = [] +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +html_last_updated_fmt = '%Y-%m-%d %H:%M' # -- Options for HTMLHelp output ------------------------------------------ diff --git a/test-requirements.txt b/test-requirements.txt index 5da13ee..87e85cf 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -8,8 +8,7 @@ flake8-import-order==0.11 # LGPLv3 mock>=2.0 # BSD # this is required for the docs build jobs -sphinx>=1.5.1 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +sphinx>=1.6.2 # BSD openstackdocstheme>=1.5.0 # Apache-2.0 doc8 # Apache-2.0 reno>=1.8.0 # Apache-2.0