From 8d593faae72e7856635cdcc64daa6c6c6777a1a3 Mon Sep 17 00:00:00 2001 From: Goutham Pacha Ravi Date: Mon, 30 Jul 2018 16:58:10 -0700 Subject: [PATCH] Switch docs to openstackdocstheme Change-Id: I6260db140fe66da321443de66231e6bf98b60fad --- doc/source/conf.py | 11 +++++++---- releasenotes/source/conf.py | 9 +++++++-- test-requirements.txt | 4 ++-- 3 files changed, 16 insertions(+), 8 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 5b1bbb5..315c6db 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,8 +22,7 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -36,6 +35,11 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' +# openstackdocstheme options +repository_name = 'openstack/paunch' +bug_project = 'paunch' +bug_tag = 'docs' + # General information about the project. project = u'paunch' copyright = u'2016, OpenStack Foundation' @@ -54,8 +58,7 @@ 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_static_path = ['static'] # Output file base name for HTML help builder. diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 3a951cf..37a46aa 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,8 +38,8 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', 'reno.sphinxext', + 'openstackdocstheme', ] # Add any paths that contain templates here, relative to this directory. @@ -111,7 +111,12 @@ 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' + +# openstackdocstheme options +repository_name = 'openstack/paunch' +bug_project = 'paunch' +bug_tag = 'docs' # 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 diff --git a/test-requirements.txt b/test-requirements.txt index 20dda9f..ad110d4 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,12 +6,12 @@ hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0 coverage>=4.0,!=4.4 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD -sphinx>=1.5.1,!=1.6.1 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +sphinx>=1.6.2 # BSD oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=1.4.0 # MIT +openstackdocstheme>=1.18.1 # Apache-2.0 # releasenotes reno>=1.8.0 # Apache-2.0