From 4a463b388cc3cf1af8135b82ef309f2a2acdf981 Mon Sep 17 00:00:00 2001 From: rajat29 Date: Fri, 14 Jul 2017 09:47:53 +0530 Subject: [PATCH] Switch from oslosphinx 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: I4b93d47de863d37f4db06877d1109fec269788d4 --- doc/source/conf.py | 10 ++++++++-- releasenotes/source/conf.py | 10 ++++++++-- test-requirements.txt | 2 +- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index aed81cb..f1e0e3d 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,9 +23,14 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme' ] +# openstackdocstheme options +repository_name = 'openstack/python-vitrageclient' +bug_project = 'python-vitrageclient' +bug_tag = '' + # 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,11 +60,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'] # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project +html_last_updated_fmt = '%Y-%m-%d %H:%M' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 6576fdf..733e130 100755 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -24,9 +24,14 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'reno.sphinxext', - 'oslosphinx' + 'openstackdocstheme' ] +# openstackdocstheme options +repository_name = 'openstack/python-vitrageclient' +bug_project = 'python-vitrageclient' +bug_tag = '' + # 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 @@ -56,8 +61,9 @@ 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'] +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 2162051..b963388 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,7 +7,7 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 coverage!=4.4,>=4.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 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD