openstack/storlets
Code Issues Proposed changes

Docs: switch to openstackdocstheme

Browse Source 
Project documents are being reprocessed due to document migration[1].
Update the docs theme to openstackdocstheme instead of oslosphinx.

[1] https://review.openstack.org/#/c/472275/

Change-Id: Iee1d82c492bbdc19e6104e74e2ec8959ff9b0978
This commit is contained in:
chenxing 2017-07-13 12:24:17 +00:00
parent e155b047b6
commit a130c988ec
2 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/conf.py
View File

@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx', #'sphinx.ext.intersphinx',
'oslosphinx' 'openstackdocstheme',
] ]
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -39,7 +39,10 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'storlets' project = u'storlets'
copyright = u'2013, OpenStack Foundation' copyright = u'2013, OpenStack Foundation'
# openstackdocstheme options
repository_name = 'openstack/storlets'
bug_project = 'storlets'
bug_tag = ''
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True add_function_parentheses = True
@ -55,9 +58,12 @@ 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_path = ["."]
# html_theme = '_theme' html_theme = 'openstackdocs'
# html_static_path = ['static'] # html_static_path = ['static']
# 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

3
test-requirements.txt
View File

@ -8,7 +8,8 @@ coverage>=3.6
nose nose
pexpect pexpect
python-subunit>=0.0.18 python-subunit>=0.0.18
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 sphinx>=1.6.2 # BSD
openstackdocstheme>=1.11.0 # Apache-2.0
oslotest>=1.2.0 # Apache-2.0 oslotest>=1.2.0 # Apache-2.0
testrepository>=0.0.18 testrepository>=0.0.18
testscenarios>=0.4 testscenarios>=0.4