From de67cbb1ac7dcfdd5823b9b2245b4cf4cc068a73 Mon Sep 17 00:00:00 2001 From: Kiran_totad Date: Tue, 4 Jul 2017 15:04:25 +0530 Subject: [PATCH] switch to openstackdocstheme As part of the docs migration work[0] for Pike we need to switch to use the openstackdocstheme. [0]https://review.openstack.org/#/c/472275/ Change-Id: Idb5e5f47f0e8c63d7142a1a43990bf586ff4dbee --- doc/source/conf.py | 11 +++++++++-- test-requirements.txt | 2 +- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 7fe810ed..a2a02dba 100644 --- 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 @@ -58,9 +58,16 @@ modindex_common_prefix = ['magnumclient.'] # 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'] +# openstackdocstheme options +repository_name = 'openstack/python-magnumclient' +bug_project = 'python-magnumclient' +bug_tag = '' +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 2aad2bac..c4956743 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -8,7 +8,7 @@ fixtures>=3.0.0 # Apache-2.0/BSD python-openstackclient!=3.10.0,>=3.3.0 # Apache-2.0 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 oslotest>=1.10.0 # Apache-2.0 osprofiler>=1.4.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD