From 3c872602ceac6813030dbe9c9e0d0742b3bac65c Mon Sep 17 00:00:00 2001 From: rajat29 Date: Thu, 6 Jul 2017 12:14:59 +0530 Subject: [PATCH] Switch from oslosphinx to openstackdocstheme As part of the docs migration work for Pike we need to switch to use the openstackdocstheme. Change-Id: I73d80355f81bd68b0072d1879a3f21154cc6c8d7 --- doc/source/conf.py | 10 ++++++++-- releasenotes/source/conf.py | 10 +++++++--- test-requirements.txt | 2 +- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 4a470a083..7472c660f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,10 +22,14 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.todo', - 'oslosphinx' + 'openstackdocstheme', #'sphinx.ext.intersphinx', ] +# openstackdocstheme options +repository_name = 'openstack/congress' +bug_project = 'congress' +bug_tag = '' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable @@ -58,12 +62,14 @@ modindex_common_prefix = ['congress.'] # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. # html_theme_path = ["."] -# html_theme = '_theme' +html_theme = 'openstackdocs' # html_static_path = ['static'] # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 4a356e0e6..8fe737593 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -36,10 +36,14 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] +# openstackdocstheme options +repository_name = 'openstack/congress' +bug_project = 'congress' +bug_tag = '' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -109,7 +113,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 @@ -147,7 +151,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 0dbd101f4..7e5a75908 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -16,8 +16,8 @@ testtools>=1.4.0 # MIT tenacity>=3.2.1 # Apache-2.0 # Doc requirements +openstackdocstheme>=1.11.0 # Apache-2.0 sphinx>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 # release note requirements reno!=2.3.1,>=1.8.0 # Apache-2.0