From 00df019f9f67bd8a97ae33f4213916184bd2f54a Mon Sep 17 00:00:00 2001 From: rabi Date: Tue, 11 Jul 2017 11:06:50 +0530 Subject: [PATCH] switch from oslosphinx to openstackdocstheme Change-Id: I042e255e544231741b7550fb92b46142ceb0e6cd --- doc/source/conf.py | 13 +++++++++---- releasenotes/source/conf.py | 11 ++++++++--- test-requirements.txt | 1 - 3 files changed, 17 insertions(+), 8 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 504e9ab8e5..cf74852189 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -77,11 +77,16 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.doctest', - 'oslosphinx', + 'openstackdocstheme', 'ext.resources', 'ext.tablefromtext', 'stevedore.sphinxext'] +# openstackdocstheme options +repository_name = 'openstack/heat' +bug_project = 'heat' +bug_tag = '' + todo_include_todos = True # Add any paths that contain templates here, relative to this directory. @@ -148,13 +153,13 @@ nitpicky = False # a list of builtin themes. # html_theme_path = ['.'] # html_theme = '_theme' +html_theme = 'openstackdocs' +html_last_updated_fmt = '%Y-%m-%d %H:%M' # 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 # documentation. -html_theme_options = { - "nosidebar": "false" -} +html_theme_options = {"sidebar_mode": "toc"} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 24bc366f38..da91e25fa1 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,10 +38,15 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] +# openstackdocstheme options +repository_name = 'openstack/heat' +bug_project = 'heat' +bug_tag = '' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -112,7 +117,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,7 +155,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 dfd4b167ce..fd058b05f6 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -14,7 +14,6 @@ PyMySQL>=0.7.6 # MIT License openstackdocstheme>=1.11.0 # Apache-2.0 os-api-ref>=1.0.0 # Apache-2.0 os-testr>=0.8.0 # Apache-2.0 -oslosphinx>=4.7.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 qpid-python;python_version=='2.7' # Apache-2.0 psycopg2>=2.5 # LGPL/ZPL