openstack/cinder
Code Issues Proposed changes

Move openstackdocstheme to extensions in api-ref

Browse Source 
Move openstackdocstheme to extensions. According to the guide below:
https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: Ibfb75e2a484b09b18cd18a4b2d21d559d7d4b475
This commit is contained in:
wanghui 2018-03-27 09:46:45 +08:00
parent fb6f96e6c3
commit 5653b99a55
1 changed files with 6 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
api-ref/source/conf.py
View File

@ -28,8 +28,6 @@ import os
import subprocess import subprocess
import sys import sys
import openstackdocstheme # noqa
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.
@ -43,7 +41,8 @@ sys.path.insert(0, os.path.abspath('./'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ extensions = [
'os_api_ref' 'os_api_ref',
'openstackdocstheme',
] ]
# The suffix of source filenames. # The suffix of source filenames.
@ -56,23 +55,12 @@ source_suffix = '.rst'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
# General information about the project.
project = u'Block Storage API Reference'
copyright = u'OpenStack Foundation' copyright = u'OpenStack Foundation'
# The version info for the project you're documenting, acts as replacement for # openstackdocstheme options
# |version| and |release|, also used in various other places throughout the repository_name = 'openstack/cinder'
# built documents. bug_project = 'cinder'
# bug_tag = 'api-ref'
from cinder.version import version_info
# The full version, including alpha/beta/rc tags.
release = version_info.release_string()
# The short X.Y version.
version = version_info.version_string()
# html_context allows us to pass arbitrary values into the html template
html_context = {"bug_tag": "api-ref",
"bug_project": "cinder"}
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -113,11 +101,9 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. Major themes that come with # The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'. # Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme' # html_theme = '_theme'
html_theme = 'openstackdocs' html_theme = 'openstackdocs'
html_theme_path = [openstackdocstheme.get_html_theme_path()]
html_theme_options = { html_theme_options = {
"sidebar_mode": "toc", "sidebar_mode": "toc",
} }