From 39271f9300ec103a849bcf8556266a434b42452f Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Tue, 11 Jul 2017 11:59:16 +0000 Subject: [PATCH] Switch from oslosphinx to openstackdocstheme Change-Id: I4ab08cd976dda6b9deb5116a7ab9d3da91fe69da --- doc/source/conf.py | 10 +++++++++- releasenotes/source/conf.py | 13 +++++++++---- test-requirements.txt | 4 ++-- 3 files changed, 20 insertions(+), 7 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index d980cdb..7a8088b 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -8,7 +8,12 @@ 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 = ['sphinx.ext.autodoc', 'oslosphinx'] +extensions = ['sphinx.ext.autodoc', 'openstackdocstheme'] + +# openstackdocstheme options +repository_name = 'openstack-dev/hacking' +bug_project = 'hacking' +bug_tag = '' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -39,6 +44,9 @@ pygments_style = 'sphinx' # -- Options for HTML output -------------------------------------------------- +html_theme = 'openstackdocs' +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # 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 5f38d1a..f078a3a 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -40,10 +40,15 @@ import pbr.version # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] +# openstackdocstheme options +repository_name = 'openstack-dev/hacking' +bug_project = 'hacking' +bug_tag = '' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -113,7 +118,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 @@ -142,7 +147,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 @@ -151,7 +156,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/test-requirements.txt b/test-requirements.txt index b719557..53f7da5 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,8 +5,8 @@ coverage>=4.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD mock>=2.0 # BSD python-subunit>=0.0.18 # Apache-2.0/BSD -sphinx>=1.5.1 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.11.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=1.4.0 # MIT