From e405a1ee7980ef46de661905658e179c479cbe79 Mon Sep 17 00:00:00 2001 From: Van Hung Pham Date: Tue, 27 Jun 2017 10:39:15 +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: I027e96e9051454233cc4ef4ee8e35f2f8b3c4ec6 --- doc/source/conf.py | 14 ++++++++------ releasenotes/source/conf.py | 10 ++++++++-- test-requirements.txt | 4 ++-- 3 files changed, 18 insertions(+), 10 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index d7ab833..20849a9 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -25,7 +25,6 @@ from __future__ import print_function import os -import subprocess import sys BASE_DIR = os.path.dirname(os.path.abspath(__file__)) @@ -167,7 +166,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', - 'oslosphinx', + 'openstackdocstheme', ] # Add any paths that contain templates here, relative to this directory. @@ -240,6 +239,7 @@ nitpicky = False # a list of builtin themes. # html_theme_path = ['.'] # html_theme = '_theme' +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 @@ -275,10 +275,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' -git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", - "-n1"] -html_last_updated_fmt = subprocess.check_output(git_cmd, - stdin=subprocess.PIPE) +html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -439,3 +436,8 @@ epub_copyright = u'2012, OpenStack' # Allow duplicate toc entries. # epub_tocdup = True + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/congress-dashboard' +bug_project = 'congress-dashboard' +bug_tag = '' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index aae2007..5396d10 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,8 +38,8 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', 'reno.sphinxext', + 'openstackdocstheme', ] # Add any paths that contain templates here, relative to this directory. @@ -111,7 +111,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 @@ -150,6 +150,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. @@ -276,3 +277,8 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/congress-dashboard' +bug_project = 'congress-dashboard' +bug_tag = '' diff --git a/test-requirements.txt b/test-requirements.txt index 157ec24..725c4fb 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -14,8 +14,8 @@ coverage>=4.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 # Docs Requirements -sphinx>=1.5.1 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.11.0 # Apache-2.0 reno>=1.8.0 # Apache-2.0 docutils>=0.11 # OSI-Approved Open Source, Public Domain