sig_cloud/diskimage-builder
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Switch from oslosphinx to openstackdocstheme

Browse Source 
Per the manuals migration effort, projects should use the
openstackdocstheme [1]

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

Change-Id: I3dbba86369326e831ec5c47e368d04e28bcb93a1
This commit is contained in:
chenxing 2017-07-14 05:46:07 +00:00 committed by Ian Wienand
parent 0327d775f1
commit 644d642e02
3 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/conf.py
View File

@ -5,7 +5,7 @@ import os
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
sys.path.append(os.path.abspath('../lib')) sys.path.append(os.path.abspath('../lib'))
extensions = ['oslosphinx', 'element_deps', 'sphinx.ext.autodoc'] extensions = ['openstackdocstheme', 'element_deps', 'sphinx.ext.autodoc']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -23,6 +23,12 @@ master_doc = 'index'
project = u'diskimage-builder' project = u'diskimage-builder'
copyright = u'2015-2016, Various Authors' copyright = u'2015-2016, Various Authors'
# openstackdocstheme options
repository_name = 'openstack/diskimage-builder'
bug_project = 'diskimage-builder'
bug_tag = ''
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
@ -80,7 +86,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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 # 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 # further. For a list of options available for each theme, see the

10
releasenotes/source/conf.py
View File

@ -4,7 +4,7 @@ import os
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ['oslosphinx', 'reno.sphinxext'] extensions = ['openstackdocstheme', 'reno.sphinxext']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -22,6 +22,12 @@ master_doc = 'index'
project = u'diskimage-builder' project = u'diskimage-builder'
copyright = u'2016, Diskimage-builder contributors' copyright = u'2016, Diskimage-builder contributors'
# openstackdocstheme options
repository_name = 'openstack/diskimage-builder'
bug_project = 'diskimage-builder'
bug_tag = ''
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
@ -76,7 +82,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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 # 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 # further. For a list of options available for each theme, see the

2
test-requirements.txt
View File

@ -12,7 +12,7 @@ testtools>=1.4.0 # MIT
# Doc requirements # Doc requirements
sphinx>=1.6.2 # BSD sphinx>=1.6.2 # BSD
oslosphinx>=4.7.0 # Apache-2.0 openstackdocstheme>=1.11.0 # Apache-2.0
# releasenotes # releasenotes
reno!=2.3.1,>=1.8.0 # Apache-2.0 reno!=2.3.1,>=1.8.0 # Apache-2.0