From f829ae8e024b45dc8ec54ba20816fec339276666 Mon Sep 17 00:00:00 2001 From: Tom Barron Date: Fri, 18 Aug 2017 07:04:40 -0400 Subject: [PATCH] doc migration: openstackdocstheme completion This patch completes the transition from oslosphinx to openstackdocstheme in accord with the OpenStack manuals project migration spec [1]. [1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Partial-Bug: #1706181 Needed-By: I6b876f6e697659a5fe7046d5c5d4fd4ed98f9828 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I834fbef9783739fd664246ff710df1ab42ce2af5 --- doc/source/conf.py | 13 +++++++++++-- test-requirements.txt | 2 +- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 319c528..975fcb1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -14,6 +14,8 @@ import os import sys +import openstackdocstheme + sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ---------------------------------------------------- @@ -22,9 +24,15 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme' ] +# openstackdocstheme options +repository_name = 'openstack/manila-image-elements' +bug_project = 'manila-image-elements' +bug_tag = 'docs' +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # 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 @@ -54,7 +62,8 @@ 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_theme = 'openstackdocs' +html_theme_path = [openstackdocstheme.get_html_theme_path()] # html_static_path = ['static'] # Output file base name for HTML help builder. diff --git a/test-requirements.txt b/test-requirements.txt index 1462284..f245017 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,4 +7,4 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 docutils>=0.11 # OSI-Approved Open Source, Public Domain sphinx>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.16.0 # Apache-2.0