From 2e1670c64f89ec3e706dc788d1933efcf4e8d139 Mon Sep 17 00:00:00 2001 From: Masayuki Igawa Date: Mon, 5 Jun 2017 14:11:36 +0900 Subject: [PATCH] Update docs theme This commit updates the docs theme to use the new one. And this commit also changed the smartypants option to False because it is useless and it changes dashes('--') into en- nad em-dash entities. We don't need that feature in our document, so far. Change-Id: I9921b8c72baf191e675d3956beca68ffd47813c2 --- doc/source/conf.py | 8 +++++--- doc/source/index.rst | 5 +++-- test-requirements.txt | 1 + 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 8d40c4f..721e53d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,6 +1,8 @@ import sys import os +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. @@ -76,7 +78,7 @@ modindex_common_prefix = ['subunit2sql.'] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'nature' +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 @@ -84,7 +86,7 @@ html_theme = 'nature' #html_theme_options = {} # 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". @@ -114,7 +116,7 @@ html_last_updated_fmt = os.popen(git_cmd).read() # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +html_use_smartypants = False # Custom sidebar templates, maps document names to template names. #html_sidebars = {} diff --git a/doc/source/index.rst b/doc/source/index.rst index 6078b64..656bb54 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,7 +2,8 @@ Subunit2SQL =========== -Contents: +Contents +======== .. toctree:: :maxdepth: 2 @@ -15,7 +16,7 @@ Contents: history -================== Indices and tables ================== + * :ref:`search` diff --git a/test-requirements.txt b/test-requirements.txt index 86a0cf9..1ef8a74 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -13,3 +13,4 @@ os-testr oslo.concurrency>=3.5.0 # releasenotes reno>=0.1.1 # Apache2 +openstackdocstheme>=1.5.0 # Apache-2.0