Fix openstackdocstheme settings

To use openstackdocstheme 1.11.0 properly, this patch fixes
some settings according to follow.
https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: I1ae26705d2d37dd6ec30c1213bc47face540f494
This commit is contained in:
Shu Muto 2017-06-28 17:32:48 +09:00
parent b3e8e259ac
commit 8992bbb87d
2 changed files with 20 additions and 13 deletions

View File

@ -15,8 +15,6 @@
import os
import sys
import openstackdocstheme
sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ----------------------------------------------------
@ -24,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'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/zun'
bug_project = 'zun'
bug_tag = ''
# General information about the project.
project = u'zun'
copyright = u'2013, OpenStack Foundation'
@ -54,9 +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_static_path = ['static']
html_theme = 'openstackdocs'
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
@ -71,5 +73,8 @@ latex_documents = [
u'OpenStack Foundation', 'manual'),
]
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Example configuration for intersphinx: refer to the Python standard library.
# intersphinx_mapping = {'http://docs.python.org/': None}

View File

@ -30,9 +30,6 @@
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
import openstackdocstheme
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
@ -40,11 +37,12 @@ import openstackdocstheme
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'openstackdocstheme',
'reno.sphinxext',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
@ -115,13 +113,18 @@ pygments_style = 'sphinx'
# a list of builtin themes.
html_theme = 'openstackdocs'
# openstackdocstheme options
repository_name = 'openstack/zun'
bug_project = 'zun'
bug_tag = ''
# 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 = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
@ -142,16 +145,15 @@ html_theme_path = [openstackdocstheme.get_html_theme_path()]
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
# html_extra_path = []
# 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'
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.