From 1cb173e6a798906f6f205b1241625bb62fb6f8df Mon Sep 17 00:00:00 2001 From: lingyongxu Date: Thu, 6 Jul 2017 09:28:05 +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: Ib35eb111e766b244d03eb9b52badb54d08efb07b --- doc/source/conf.py | 12 ++++++++++-- releasenotes/source/conf.py | 15 ++++++++++----- test-requirements.txt | 2 +- 3 files changed, 21 insertions(+), 8 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 2933150..04d3623 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,9 +23,17 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme' ] +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/oslosphinx' +bug_project = 'oslosphinx' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + oslosphinx_cgit_link = 'https://git.openstack.org/cgit/openstack/oslosphinx' # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -57,7 +65,7 @@ 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. diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 7a65008..3f7d764 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -35,12 +35,12 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +#templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' @@ -109,7 +109,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 @@ -138,7 +138,7 @@ html_theme = 'default' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied @@ -147,7 +147,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. @@ -274,3 +274,8 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/oslosphinx' +bug_project = 'oslosphinx' +bug_tag = '' diff --git a/test-requirements.txt b/test-requirements.txt index 96347b1..e50ac1b 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,5 +6,5 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 # this is required for the docs build jobs sphinx>=1.6.2 # BSD - +openstackdocstheme>=1.11.0 # Apache-2.0 reno!=2.3.1,>=1.8.0 # Apache-2.0