From efa324ac0586ab14a0c26fd08124ac7cae3efb25 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Thu, 22 Jun 2017 13:31:19 -0400 Subject: [PATCH] switch from oslosphinx to openstackdocstheme Change-Id: Ife54259642bd71b899d34fa8d18ccc90e6f35bc2 Signed-off-by: Doug Hellmann --- doc/source/conf.py | 6 +++++- doc/source/index.rst | 3 +-- test-requirements.txt | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index ff997ae..ae8e7d8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -15,6 +15,8 @@ import datetime import subprocess +import openstackdocstheme + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -28,7 +30,7 @@ import subprocess # 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', 'oslosphinx'] +extensions = ['sphinx.ext.autodoc'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -98,6 +100,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 @@ -106,6 +109,7 @@ pygments_style = 'sphinx' # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] +html_theme_path = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/source/index.rst b/doc/source/index.rst index c9d1b47..ec31348 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,8 +15,7 @@ extensions. contributors/index -Indices and tables -================== +.. rubric:: Indices and tables * :ref:`genindex` * :ref:`modindex` diff --git a/test-requirements.txt b/test-requirements.txt index 8b0da0e..ff80475 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -12,4 +12,4 @@ coverage!=4.4,>=4.0 # Apache-2.0 # this is required for the docs build jobs sphinx>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0