From bd35a6e841550cb01c4bbf94979805369474db54 Mon Sep 17 00:00:00 2001 From: Dong Ma Date: Sat, 1 Jul 2017 08:51:47 +0800 Subject: [PATCH] switch from oslosphinx to openstackdocstheme Change-Id: I66319c2b4e4ec4c10133151f7a867bdca7a3afa8 --- doc/source/conf.py | 11 +++++++++-- releasenotes/source/conf.py | 10 +++++++--- setup.cfg | 2 +- 3 files changed, 17 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 00f65cbb..576e270b 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,9 +23,16 @@ extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', 'oslo_config.sphinxext', - 'oslosphinx', + 'openstackdocstheme', 'stevedore.sphinxext' ] +# openstackdocstheme options +repository_name = 'openstack/oslo.db' +bug_project = 'oslo.db' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -66,7 +73,7 @@ modindex_common_prefix = ['oslo_db.'] # 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 e5cc22e0..eb70f788 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,9 +38,13 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] +# openstackdocstheme options +repository_name = 'openstack/oslo.db' +bug_project = 'oslo.db' +bug_tag = '' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -112,7 +116,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 +154,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 7cf82668..9f3ea27a 100644 --- a/setup.cfg +++ b/setup.cfg @@ -38,7 +38,7 @@ test = mock>=2.0 # BSD python-subunit>=0.0.18 # Apache-2.0/BSD sphinx>=1.6.2 # BSD - oslosphinx>=4.7.0 # Apache-2.0 + openstackdocstheme>=1.11.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 oslo.context>=2.14.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD