From 0d0192c47225e2de41265cbee7141f1a8b4ed39b Mon Sep 17 00:00:00 2001 From: Yumeng Bao Date: Mon, 26 Jun 2017 20:28:53 +0800 Subject: [PATCH] switch to openstackdocstheme Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I93dfcbd516810c41a1d64e872a28a539ec4f3155 --- doc/source/conf.py | 19 +++++++++++++++---- test-requirements.txt | 2 +- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 4bf62b5..54bf344 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -11,6 +11,7 @@ # See the License for the specific language governing permissions and # limitations under the License. + from watcherclient import version as watcherclient_version # -- General configuration ---------------------------------------------------- @@ -19,9 +20,8 @@ from watcherclient import version as watcherclient_version # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', - 'oslosphinx', - ] - + 'openstackdocstheme', + ] # 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 @@ -69,7 +69,8 @@ pygments_style = 'sphinx' # html_theme_path = ["."] # html_theme = '_theme' # html_static_path = ['_static'] -html_theme_options = {'incubating': True} +html_theme = 'openstackdocs' +# html_theme_path = [openstackdocstheme.get_html_theme_path()] # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project @@ -86,3 +87,13 @@ latex_documents = [ u'OpenStack Foundation', 'manual' ), ] + +# openstackdocstheme options +repository_name = 'openstack/python-watcherclient' +bug_project = 'python-watcherclient' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + +#html_theme_options = {"show_other_versions": "True"} diff --git a/test-requirements.txt b/test-requirements.txt index 0052f5b..1d2af5d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,7 +6,7 @@ coverage!=4.4,>=4.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 mock>=2.0 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD sphinx>=1.6.2 # BSD