From 1c8c0e4d2989434120d4d4664d293ce1bd03a405 Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Fri, 14 Jul 2017 10:06:14 +0800 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: I38a2ef0ac57c15e367963ffabab3ddd7e8106bc2 --- doc/source/conf.py | 12 ++++++++++-- releasenotes/source/conf.py | 11 ++++++++--- test-requirements.txt | 4 ++-- 3 files changed, 20 insertions(+), 7 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index e4ba2390d..836bc9a90 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -21,9 +21,9 @@ sys.path.insert(0, os.path.abspath('../..')) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ + 'openstackdocstheme', 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -55,9 +55,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'] +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project @@ -73,3 +76,8 @@ latex_documents = [ # Example configuration for intersphinx: refer to the Python standard library. #intersphinx_mapping = {'http://docs.python.org/': None} + +# openstackdocstheme options +repository_name = 'openstack/kolla-kubernetes' +bug_project = 'kolla-kubernetes' +bug_tag = '' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 8f97bb6aa..95465f174 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -30,7 +30,7 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -102,7 +102,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'openstackdocs' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -140,7 +140,7 @@ html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -252,3 +252,8 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# openstackdocstheme options +repository_name = 'openstack/kolla-kubernetes' +bug_project = 'kolla-kubernetes' +bug_tag = '' diff --git a/test-requirements.txt b/test-requirements.txt index 441a61395..f854c1418 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,8 +7,8 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 reno!=2.3.1,>=1.8.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD -sphinx!=1.6.1,>=1.5.1 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +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