doc: update the theme and simplify the options
- sync with the latest version of openstackdocstheme (as per global requirements); - use the configuration options described in the documentation of openstackdocstheme; - also, update few doc-related requirements (at least sphinx is needed). Change-Id: Ie36cbdf21e453eb9225b62938f3243a80963c17d
This commit is contained in:
parent
b13eb256bc
commit
f964485ae1
|
@ -11,10 +11,6 @@
|
|||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys, 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.
|
||||
|
@ -27,7 +23,16 @@ import openstackdocstheme
|
|||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = ['reno.sphinxext']
|
||||
extensions = [
|
||||
'reno.sphinxext',
|
||||
'openstackdocstheme',
|
||||
]
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/sahara-tests'
|
||||
bug_project = 'sahara-tests'
|
||||
bug_tag = 'doc'
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
@ -94,7 +99,6 @@ pygments_style = 'sphinx'
|
|||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'openstackdocs'
|
||||
html_theme_path = [openstackdocstheme.get_html_theme_path()]
|
||||
|
||||
# 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
|
||||
|
@ -123,20 +127,12 @@ 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']
|
||||
|
||||
# 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'
|
||||
|
||||
giturl = u'http://git.openstack.org/cgit/openstack/sahara-tests/tree/releasenotes/source'
|
||||
# html_context allows us to pass arbitrary values into the html template
|
||||
html_context = {
|
||||
"bug_tag": "releasenotes",
|
||||
"giturl": giturl,
|
||||
"bug_project": "sahara-tests"
|
||||
}
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
html_use_smartypants = False
|
||||
|
|
|
@ -14,12 +14,17 @@
|
|||
|
||||
# Sahara-tests Release Notes documentation build configuration file
|
||||
|
||||
import openstackdocstheme
|
||||
|
||||
extensions = [
|
||||
'reno.sphinxext',
|
||||
'openstackdocstheme'
|
||||
]
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/sahara-tests'
|
||||
bug_project = 'sahara-tests'
|
||||
bug_tag = 'releasenotes'
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
|
@ -89,7 +94,6 @@ pygments_style = 'sphinx'
|
|||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'openstackdocs'
|
||||
html_theme_path = [openstackdocstheme.get_html_theme_path()]
|
||||
|
||||
# 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
|
||||
|
@ -129,16 +133,6 @@ html_static_path = ['_static']
|
|||
# using the given strftime format.
|
||||
# html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
giturl = (
|
||||
u'http://git.openstack.org/cgit/openstack/sahara-tests/tree/doc/source'
|
||||
)
|
||||
# html_context allows us to pass arbitrary values into the html template
|
||||
html_context = {
|
||||
"bug_tag": "doc",
|
||||
"giturl": giturl,
|
||||
"bug_project": "sahara-tests"
|
||||
}
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
# html_use_smartypants = True
|
||||
|
|
|
@ -8,7 +8,7 @@ bashate>=0.2 # Apache-2.0
|
|||
coverage>=3.6 # Apache-2.0
|
||||
doc8 # Apache-2.0
|
||||
mock>=1.2 # BSD
|
||||
openstackdocstheme>=1.5.0 # Apache-2.0
|
||||
openstackdocstheme>=1.11.0 # Apache-2.0
|
||||
pylint==1.4.5 # GNU GPL v2
|
||||
reno>=1.6.2 # Apache2
|
||||
sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD
|
||||
reno!=2.3.1,>=1.8.0 # Apache-2.0
|
||||
sphinx>=1.6.2 # BSD
|
||||
|
|
Loading…
Reference in New Issue