Switch from oslosphinx to openstackdocstheme

As part of the docs migration work[0] for Pike we need to switch to use the
openstackdocstheme.

[0] https://review.openstack.org/#/c/472275/

Change-Id: Id42feb91af894d58b55a3f4504a5c0569523d02d
This commit is contained in:
Emilien Macchi 2017-06-27 16:35:06 -04:00
parent 0a5dc8de8d
commit 84fc3f1d24
3 changed files with 17 additions and 8 deletions

View File

@ -21,6 +21,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'openstackdocstheme',
'sphinx.ext.autodoc',
]
@ -45,9 +46,6 @@ add_function_parentheses = True
# unit titles (such as .. function::).
add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
@ -58,6 +56,7 @@ pygments_style = 'sphinx'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
html_theme = 'openstackdocs'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
@ -71,3 +70,8 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
# intersphinx_mapping = {'http://docs.python.org/': None}
# openstackdocstheme options
repository_name = 'openstack/tripleo-quickstart'
bug_project = 'tripleo'
bug_tag = 'documentation'

View File

@ -28,7 +28,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'oslosphinx',
'openstackdocstheme',
'reno.sphinxext',
]
@ -102,7 +102,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
@ -262,4 +262,9 @@ texinfo_documents = [
#texinfo_no_detailmenu = False
# -- Options for Internationalization output ------------------------------
locale_dirs = ['locale/']
locale_dirs = ['locale/']
# openstackdocstheme options
repository_name = 'openstack/tripleo-quickstart'
bug_project = 'tripleo'
bug_tag = 'documentation'

View File

@ -1,9 +1,9 @@
openstackdocstheme>=1.11.0 # Apache-2.0
hacking<0.11,>=0.10
bashate>=0.2 # Apache-2.0
ansible-lint
jenkins-job-builder
docutils>=0.11
sphinx>=1.5.1 # BSD
oslosphinx>=4.7.0 # Apache-2.0
sphinx>=1.6.2 # BSD
reno>=1.8.0 # Apache-2.0