From e0a0782a80e9dcbd3b1a4eabe9cbf8bb84bde081 Mon Sep 17 00:00:00 2001 From: Van Hung Pham Date: Wed, 28 Jun 2017 12:00:03 +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: Idf8ddcb0c76c4d211881e6ccb1bef82efffdbb70 --- doc/source/conf.py | 15 ++++++++++++--- releasenotes/source/conf.py | 12 ++++++++---- requirements.txt | 2 +- 3 files changed, 21 insertions(+), 8 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index f702e79b9..b9a7b4bfb 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,7 @@ extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', 'stevedore.sphinxext', - 'oslosphinx' + 'openstackdocstheme', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -57,13 +57,17 @@ modindex_common_prefix = ['tacker.'] # 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]). @@ -76,3 +80,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/tacker' +bug_project = 'tacker' +bug_tag = '' \ No newline at end of file diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 5f425e232..abf10a0fd 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -36,8 +36,8 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ - 'oslosphinx', - 'reno.sphinxext' + 'reno.sphinxext', + 'openstackdocstheme', ] # Add any paths that contain templates here, relative to this directory. @@ -105,7 +105,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 @@ -113,7 +113,6 @@ html_theme = 'default' # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -260,3 +259,8 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/tacker' +bug_project = 'tacker' +bug_tag = '' diff --git a/requirements.txt b/requirements.txt index 27563e314..34cb2f66f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -33,7 +33,7 @@ oslo.rootwrap>=5.0.0 # Apache-2.0 oslo.serialization>=1.10.0 # Apache-2.0 oslo.service>=1.10.0 # Apache-2.0 oslo.utils>=3.20.0 # Apache-2.0 -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 python-neutronclient>=6.3.0 # Apache-2.0 python-novaclient>=9.0.0 # Apache-2.0 tosca-parser>=0.8.1 # Apache-2.0