From 5dbb8c8c0065742cf61bde9b2fb90f0b8b1a297b Mon Sep 17 00:00:00 2001 From: Dong Ma Date: Sun, 25 Jun 2017 01:08:57 +0800 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: I9f5d44dfdfeeab87ced0936318d95741d62845ba --- doc/source/conf.py | 14 ++++++++------ releasenotes/source/conf.py | 13 +++++++++---- test-requirements.txt | 4 ++-- 3 files changed, 19 insertions(+), 12 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 721e53d..9b341eb 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,8 +1,6 @@ import sys import os -import openstackdocstheme - # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -18,9 +16,14 @@ import openstackdocstheme extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode', - 'oslosphinx' + 'openstackdocstheme' ] +# openstackdocstheme options +repository_name = 'openstack-infra/subunit2sql' +bug_project = 'subunit2sql' +bug_tag = '' + todo_include_todos = True # Add any paths that contain templates here, relative to this directory. @@ -86,7 +89,7 @@ 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 = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -111,8 +114,7 @@ html_static_path = ['_static'] # 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 = os.popen(git_cmd).read() +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/releasenotes/source/conf.py b/releasenotes/source/conf.py index a782265..6e2b91d 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -26,10 +26,15 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', 'reno.sphinxext', + 'openstackdocstheme' ] +# openstackdocstheme options +repository_name = 'openstack-infra/subunit2sql' +bug_project = 'subunit2sql' +bug_tag = '' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -101,7 +106,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 @@ -109,7 +114,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -139,7 +144,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. diff --git a/test-requirements.txt b/test-requirements.txt index 1ef8a74..78b3cca 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,7 +2,7 @@ hacking>=0.12.0,!=0.13.0,<0.14 coverage>=3.6 fixtures>=0.3.14 mock>=1.0 -sphinx>=1.1.2,<1.2 +sphinx>=1.6.2 # BSD testscenarios>=0.4 testrepository>=0.0.18 testtools>=0.9.34 @@ -13,4 +13,4 @@ os-testr oslo.concurrency>=3.5.0 # releasenotes reno>=0.1.1 # Apache2 -openstackdocstheme>=1.5.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0