switch to openstackdocstheme

Change-Id: I71aac9c5e629e88fa8009ce4b303c658c3e37fd2
Co-Authored-By: chenxing <chen.xing@99cloud.net>
This commit is contained in:
Yumeng_Bao 2017-07-11 11:22:26 +08:00 committed by chenxing
parent 078d3577c8
commit cbfa8bf76e
3 changed files with 27 additions and 8 deletions

View File

@ -18,7 +18,7 @@
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'oslosphinx', 'openstackdocstheme',
] ]
wsme_protocols = ['restjson'] wsme_protocols = ['restjson']
@ -35,7 +35,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Watcher' project = u'Watcher Dashboard'
copyright = u'OpenStack Foundation' copyright = u'OpenStack Foundation'
# 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
@ -84,7 +84,9 @@ man_pages = []
# html_theme_path = ["."] # html_theme_path = ["."]
# html_theme = '_theme' # html_theme = '_theme'
# html_static_path = ['static'] # html_static_path = ['static']
html_theme_options = {'incubating': True} # html_theme_options = {'incubating': True}
# html_theme_options = {"show_other_versions": "True"}
html_theme = 'openstackdocs'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project
@ -101,3 +103,11 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library. # Example configuration for intersphinx: refer to the Python standard library.
# intersphinx_mapping = {'http://docs.python.org/': None} # intersphinx_mapping = {'http://docs.python.org/': None}
# openstackdocstheme options
repository_name = 'openstack/watcher-dashboard'
bug_project = 'watcher-dashboard'
bug_tag = ''
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'

View File

@ -37,7 +37,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'oslosphinx', 'openstackdocstheme',
'reno.sphinxext', 'reno.sphinxext',
] ]
@ -111,12 +111,21 @@ 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'
# openstackdocstheme options
repository_name = 'openstack/watcher-dashboard'
bug_project = 'watcher-dashboard'
bug_tag = ''
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# 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
# documentation. # documentation.
# html_theme_options = {} # html_theme_options = {"show_other_versions": "True"}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = [] # html_theme_path = []

View File

@ -21,6 +21,6 @@ testtools>=1.4.0 # MIT
xvfbwrapper>=0.1.3 #license: MIT xvfbwrapper>=0.1.3 #license: MIT
# Doc requirements # Doc requirements
oslosphinx>=4.7.0 # Apache-2.0 openstackdocstheme>=1.11.0 # Apache-2.0
sphinx!=1.6.1,>=1.5.1 # BSD sphinx>=1.6.2 # BSD
reno>=1.8.0 # Apache-2.0 reno>=1.8.0 # Apache-2.0