From d9802e0275e38c2d102be3f72d2b556a9483e1ab Mon Sep 17 00:00:00 2001 From: Hanxi Liu Date: Fri, 23 Jun 2017 11:11:18 +0800 Subject: [PATCH] Docs: switch to openstackdocstheme Project documents are being reprocessed due to document migration[1]. Update the docs theme to openstackdocstheme instead of oslosphinx. [1] https://review.openstack.org/#/c/472275/ Change-Id: I749481139eddc4df012d2a63a4c5c258a72692d1 Co-Authored-By: chenxing --- doc/source/conf.py | 12 ++++++++++-- releasenotes/source/conf.py | 14 +++++++------- setup.cfg | 4 ++-- 3 files changed, 19 insertions(+), 11 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 0f496da..e773332 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -63,8 +63,8 @@ gen_ref("v2", "Version 2 API", ["client"]) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', + 'openstackdocstheme', #'sphinx.ext.intersphinx', - 'oslosphinx' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -77,7 +77,10 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' -# General information about the project. +# openstackdocstheme options +repository_name = 'openstack/python-aodhclient' +bug_project = 'python-aodhclient' +bug_tag = '' project = u'aodhclient' copyright = u'2015, OpenStack Foundation' @@ -98,6 +101,11 @@ pygments_style = 'sphinx' # html_theme_path = ["."] # html_theme = '_theme' # html_static_path = ['static'] +html_theme = 'openstackdocs' +html_last_updated_fmt = '%Y-%m-%d %H:%M' + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = ['_theme'] # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index a5d6159..a507b8d 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -12,9 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. # -# Aodh Client Release Notes documentation build configuration file, created by -# sphinx-quickstart on Mon Nov 23 20:38:38 2015. -# # This file is execfile()d with the current directory set to its # containing dir. # @@ -38,7 +35,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -54,7 +51,10 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' -# General information about the project. +# openstackdocstheme options +repository_name = 'openstack/python-aodhclient' +bug_project = 'python-aodhclient' +bug_tag = '' project = u'Aodh Client Release Notes' copyright = u'2015-present, Aodh developers' @@ -112,7 +112,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 @@ -150,7 +150,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. diff --git a/setup.cfg b/setup.cfg index 962f267..9a01274 100644 --- a/setup.cfg +++ b/setup.cfg @@ -35,8 +35,8 @@ test = gnocchi[postgresql,file] mock>=1.2 # BSD doc = - sphinx!=1.2.0,!=1.3b1,!=1.6.1,>=1.1.2 - oslosphinx>=2.5.0 # Apache-2.0 + sphinx>=1.6.2 # BSD + openstackdocstheme>=1.11.0 # Apache-2.0 [entry_points] console_scripts =