openstack/ironic-python-agent
Code Issues Proposed changes

Switch from oslosphinx to openstackdocstheme

Browse Source 
Change-Id: I1aecf894955e8095c11b8fb82d60488e5d0aca5f
This commit is contained in:
Julia Kreger 2017-07-04 01:10:43 +00:00
parent 85f627157d
commit 774d995b7f
3 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/conf.py
View File

@ -10,7 +10,7 @@ extensions = ['sphinx.ext.autodoc',
'sphinxcontrib.httpdomain', 'sphinxcontrib.httpdomain',
'sphinxcontrib.pecanwsme.rest', 'sphinxcontrib.pecanwsme.rest',
'wsmeext.sphinxext', 'wsmeext.sphinxext',
'oslosphinx', 'openstackdocstheme',
] ]
wsme_protocols = ['restjson'] wsme_protocols = ['restjson']
@ -66,9 +66,15 @@ suppress_warnings = ['app.add_directive']
# 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 = 'openstackdocs'
#html_theme = '_theme'
#html_static_path = ['_static'] # openstackdocstheme options
repository_name = 'openstack/ironic-python-agent'
bug_project = 'ironic-python-agent'
bug_tag = ''
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project

9
releasenotes/source/conf.py
View File

@ -38,7 +38,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',
] ]
@ -112,7 +112,12 @@ 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/ironic-python-agent'
bug_project = 'ironic-python-agent'
bug_tag = ''
# 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

@ -15,5 +15,5 @@ flake8-import-order==0.11 # LGPLv3
doc8 # Apache-2.0 doc8 # Apache-2.0
sphinx>=1.6.2 # BSD sphinx>=1.6.2 # BSD
sphinxcontrib-pecanwsme>=0.8 # Apache-2.0 sphinxcontrib-pecanwsme>=0.8 # Apache-2.0
oslosphinx>=4.7.0 # Apache-2.0 openstackdocstheme>=1.11.0 # Apache-2.0
reno!=2.3.1,>=1.8.0 # Apache-2.0 reno!=2.3.1,>=1.8.0 # Apache-2.0