From b0ff9aaaa5d6c6c6200b91b3543a76dbf7d972de Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Mon, 26 Jun 2017 11:48:41 +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: Ib82ae202e347c17d255b3c91149474151a59eac3 --- doc/conf.py | 14 +++++++++++--- releasenotes/source/conf.py | 12 ++++++++++-- test-requirements.txt | 2 +- 3 files changed, 22 insertions(+), 6 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 09287f8d5d..d4a23cab23 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -21,8 +21,8 @@ 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', - 'oslosphinx' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -64,13 +64,16 @@ 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_path = [] +html_theme = 'openstackdocs' # html_static_path = ['static'] # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project +# Must set this variable to include year, month, day, hours, and minutes. +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 # [howto/manual]). @@ -80,3 +83,8 @@ latex_documents = [ u'%s Documentation' % project, u'OpenStack Foundation', 'manual'), ] + +# openstackdocstheme options +repository_name = 'openstack/kolla' +bug_project = 'kolla' +bug_tag = '' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index f4a3215a7d..0ddba13a12 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -30,8 +30,8 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', 'reno.sphinxext', + 'openstackdocstheme', ] # Add any paths that contain templates here, relative to this directory. @@ -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 @@ -116,6 +116,9 @@ html_theme = 'default' # " v documentation". # html_title = None +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = None @@ -252,3 +255,8 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# openstackdocstheme options +repository_name = 'openstack/kolla' +bug_project = 'kolla' +bug_tag = '' diff --git a/test-requirements.txt b/test-requirements.txt index c0a15dd905..dae3e8767d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,9 +10,9 @@ doc8 # Apache-2.0 extras # MIT graphviz!=0.5.0,>=0.4.0 # MIT License hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 oslo.log>=3.22.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 -oslosphinx>=4.7.0 # Apache-2.0 reno!=2.3.1,>=1.8.0 # Apache-2.0 PrettyTable<0.8,>=0.7.1 # BSD PyYAML>=3.10.0 # MIT