From 4961bc7d64a342b8434a39c69fa0cbfcb8935b96 Mon Sep 17 00:00:00 2001 From: Nguyen Hai Date: Mon, 19 Mar 2018 15:34:56 +0900 Subject: [PATCH] Use openstackdocstheme for python-tripleoclient Apply for python-tripleoclient webpage and releasenotes Change-Id: I859cb176a95bcd73b0175c30b079a8781f5bf295 Ref: https://docs.openstack.org/openstackdocstheme/ --- doc/requirements.txt | 5 +---- doc/source/conf.py | 12 ++++++++++-- releasenotes/source/conf.py | 2 +- 3 files changed, 12 insertions(+), 7 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index d622b48aa..b9c5e1f17 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,3 @@ -# The order of packages is significant, because pip processes them in the order -# of appearance. Changing the order has an impact on the overall integration -# process, which may cause wedges in the gate later. -oslosphinx>=4.7.0 # Apache-2.0 sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +openstackdocstheme>=1.18.1 # Apache-2.0 reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 905b78fff..d63a7c693 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', - # 'oslo.sphinx' + 'openstackdocstheme' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -57,7 +57,7 @@ suppress_warnings = ['image.nonlocal_uri'] # 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. @@ -72,3 +72,11 @@ latex_documents = [ u'%s Documentation' % project, u'OpenStack Foundation', 'manual'), ] + +# openstackdocstheme options +repository_name = 'openstack/python-tripleoclient' +bug_project = 'python-tripleoclient' +bug_tag = '' + +# Last updated timestamp +html_last_updated_fmt = '%Y-%m-%d %H:%M' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 8e9b020ec..a96e463e5 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -27,7 +27,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ]