From acce498868a3708b209109ce3167fe0b840fe2b7 Mon Sep 17 00:00:00 2001 From: lingyongxu Date: Wed, 5 Jul 2017 16:31:28 +0800 Subject: [PATCH] Switch from oslosphinx to openstackdocstheme To use openstackdocstheme 1.11.0 properly, this patch fixes some settings according to follow. https://docs.openstack.org/openstackdocstheme/latest/ Change-Id: I66fa03c1b528a216de12f7b9ce1de38de907f0a4 --- doc/source/conf.py | 12 ++++++++++-- test-requirements.txt | 2 +- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 265a8ef..31fe2b1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,9 +23,17 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme' ] +# openstackdocstheme options +repository_name = 'openstack/python-congressclient' +bug_project = 'python-congressclient' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable @@ -55,7 +63,7 @@ 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'] # Output file base name for HTML help builder. diff --git a/test-requirements.txt b/test-requirements.txt index 4096ca7..95b6eb3 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,7 +7,7 @@ coverage!=4.4,>=4.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD python-subunit>=0.0.18 # Apache-2.0/BSD sphinx>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=1.4.0 # MIT mock>=2.0 # BSD