doc migration: openstackdocstheme completion

This patch completes the transition from oslosphinx
to openstackdocs theme in accord with the OpenStack
manuals project migration spec [1].

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I72be6303f9be77c0461eaacbc61bad8372546fb5
Partial-Bug: #1706181
Needed-By: I8964d066bb838fabbe94239ac108bff884c6ff76
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
(cherry picked from commit f98e4f6723)
This commit is contained in:
Tom Barron 2017-08-18 06:56:28 -04:00
parent 20eafe56b7
commit 2183b59157
2 changed files with 14 additions and 10 deletions

View File

@ -3,6 +3,8 @@
import os
import sys
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.
@ -20,14 +22,6 @@ sys.path.append(os.path.abspath('exts'))
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'openstackdocstheme', 'clidoc']
# openstackdocstheme options
repository_name = 'openstack/python-manilaclient'
bug_project = 'python-manilaclient'
bug_tag = ''
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -69,3 +63,11 @@ pygments_style = 'sphinx'
# Output file base name for HTML help builder.
htmlhelp_basename = 'python-manilaclientdoc'
html_theme = 'openstackdocs'
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# openstackdocstheme options
repository_name = 'openstack/python-manilaclient'
bug_project = 'python-manilaclient'
bug_tag = 'docs'
html_last_updated_fmt = '%Y-%m-%d %H:%M'

View File

@ -32,6 +32,8 @@
import pbr.version
import openstackdocstheme
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
@ -46,7 +48,7 @@ extensions = [
# openstackdocstheme options
repository_name = 'openstack/python-manilaclient'
bug_project = 'python-manilaclient'
bug_tag = ''
bug_tag = 'release notes'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Add any paths that contain templates here, relative to this directory.
@ -128,7 +130,7 @@ html_theme = 'openstackdocs'
# 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
# "<project> v<release> documentation".