From a130c988ec2951909e90899ddcfc2326676083d7 Mon Sep 17 00:00:00 2001 From: chenxing Date: Thu, 13 Jul 2017 12:24:17 +0000 Subject: [PATCH] Docs: switch to openstackdocstheme 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 --- doc/source/conf.py | 12 +++++++++--- test-requirements.txt | 3 ++- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 8e08f673..15139a8e 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -39,7 +39,10 @@ master_doc = 'index' # General information about the project. project = u'storlets' 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. 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 # Sphinx are currently 'default' and 'sphinxdoc'. # html_theme_path = ["."] -# html_theme = '_theme' +html_theme = 'openstackdocs' # 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. htmlhelp_basename = '%sdoc' % project diff --git a/test-requirements.txt b/test-requirements.txt index e5cd1f84..7b200fd3 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -8,7 +8,8 @@ coverage>=3.6 nose pexpect 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 testrepository>=0.0.18 testscenarios>=0.4