From acf517bb3e1a391a82cdba9807d3a2ba9e9eacb7 Mon Sep 17 00:00:00 2001 From: Van Hung Pham Date: Wed, 28 Jun 2017 10:59:16 +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: Ie9b81c1edeb938ad9e5e06ee2d604ce28a9dea43 --- doc/source/conf.py | 15 ++++++++++++--- releasenotes/source/conf.py | 15 ++++++++++++--- test-requirements.txt | 4 ++-- 3 files changed, 26 insertions(+), 8 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 802e5c6..699d343 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', # 'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -54,13 +54,17 @@ pygments_style = 'sphinx' # 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_static_path = ['static'] +html_theme = 'openstackdocs' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project +# 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' + # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). @@ -73,3 +77,8 @@ latex_documents = [ # Example configuration for intersphinx: refer to the Python standard library. # intersphinx_mapping = {'http://docs.python.org/': None} + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/vitrage-dashboard' +bug_project = 'vitrage-dashboard' +bug_tag = '' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 0e62592..52601a3 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -24,7 +24,7 @@ extensions = [ 'sphinx.ext.autodoc', # 'sphinx.ext.intersphinx', 'reno.sphinxext', - 'oslosphinx' + 'openstackdocstheme', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -55,13 +55,17 @@ pygments_style = 'sphinx' # 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_static_path = ['static'] +html_theme = 'openstackdocs' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project +# 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' + # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). @@ -77,3 +81,8 @@ latex_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/vitrage-dashboard' +bug_project = 'vitrage-dashboard' +bug_tag = '' diff --git a/test-requirements.txt b/test-requirements.txt index 249b91e..65824ac 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,8 +6,8 @@ hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0 coverage>=3.6 python-subunit>=0.0.18 -sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 -oslosphinx>=2.5.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.11.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 testscenarios>=0.4