From a04f5f10e10a1acaf08dee38d7dfd817206a1c84 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 7 Jul 2017 14:31:16 -0400 Subject: [PATCH] switch from oslosphinx to openstackdocstheme Change-Id: Ieadf9b992b269d54dd9c79523d5879b6ad71ba7c Signed-off-by: Doug Hellmann --- doc/source/conf.py | 10 ++++++++-- releasenotes/source/conf.py | 10 ++++++++-- test-requirements.txt | 2 +- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 850bbfe..fa7a79a 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,10 +23,16 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - 'oslosphinx', + 'openstackdocstheme', 'oslo_config.sphinxext', ] +# openstackdocstheme options +repository_name = 'openstack/oslo.concurrency' +bug_project = 'oslo.concurrency' +bug_tag = '' +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable @@ -60,7 +66,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 833006e..0da117c 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -35,10 +35,16 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] +# openstackdocstheme options +repository_name = 'openstack/oslo.config' +bug_project = 'oslo.config' +bug_tag = '' +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -109,7 +115,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 diff --git a/test-requirements.txt b/test-requirements.txt index be9e70b..a4fdb12 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,7 +9,7 @@ futures>=3.0;python_version=='2.7' or python_version=='2.6' # BSD fixtures>=3.0.0 # Apache-2.0/BSD # These are needed for docs generation -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 sphinx>=1.6.2 # BSD reno!=2.3.1,>=1.8.0 # Apache-2.0