From db66ea6100cd7cebaae3050308991f6d24f59cb1 Mon Sep 17 00:00:00 2001 From: klyang Date: Mon, 10 Jul 2017 11:14:26 +0800 Subject: [PATCH] switch from oslosphinx to openstackdocstheme Change-Id: I56ac175ea046c0bcd1e1b2d515e4279437739d91 ref:https://docs.openstack.org/openstackdocstheme/latest/ --- doc/source/conf.py | 14 +++++++++----- requirements.txt | 2 +- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index a98a0da3..2e6df4ab 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -31,10 +31,15 @@ import os extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode', - 'oslosphinx', + 'openstackdocstheme', 'yasfb', ] +# openstackdocstheme options +repository_name = 'openstack/cinder-specs' +bug_project = 'cinder-specs' +bug_tag = 'doc' + # Feed configuration for yasfb feed_base_url = 'http://specs.openstack.org/openstack/cinder-specs' feed_author = 'OpenStack Cinder Team' @@ -101,7 +106,7 @@ man_pages = [] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -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 @@ -129,9 +134,8 @@ html_theme = 'nature' # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", - "-n1"] -html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8') + +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/requirements.txt b/requirements.txt index b245899f..32cefcda 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -oslosphinx +openstackdocstheme>=1.11.0 pbr>=0.6,<1.0 sphinx>=1.6.2 # BSD testrepository>=0.0.18