From 95ddcbe9660e990b8fae0f3b492e251c9c87bd52 Mon Sep 17 00:00:00 2001 From: dharmendra Date: Fri, 7 Jul 2017 01:04:42 +0000 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: Ia48ca6860012850071f8c236d404d56a480b747c --- doc/source/conf.py | 18 ++++++++++++++++-- releasenotes/source/conf.py | 10 ++++++++-- requirements.txt | 1 + 3 files changed, 25 insertions(+), 4 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index c3cadb70..4ca6871c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -4,7 +4,10 @@ project = 'python-tackerclient' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'openstackdocstheme' +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -32,12 +35,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 = 'nature' +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]). @@ -50,3 +58,9 @@ 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/python-tackerclient' +bug_project = 'python-tackerclient' +bug_tag = '' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 1937a882..c3ac943c 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -37,7 +37,8 @@ # 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 +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 @@ -262,3 +263,8 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/python-tackerclient' +bug_project = 'python-tackerclient' +bug_tag = '' diff --git a/requirements.txt b/requirements.txt index da31f119..4ed021d0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -17,3 +17,4 @@ oslo.log>=3.22.0 # Apache-2.0 oslo.utils>=3.20.0 # Apache-2.0 oslosphinx>=4.7.0 # Apache-2.0 oslo.serialization>=1.10.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0