From b52e5f2f14692364333a5b7bc6993fe1f133d15b Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 29 Jun 2017 11:01:49 +0200 Subject: [PATCH] Update for openstackdocstheme 1.11 Update for most recent openstackdocstheme, use it for releasenotes as well. Change-Id: I0a04bb69553c30f23091444ef893f854bbf6e857 --- {{cookiecutter.repo_name}}/doc/source/conf.py | 12 +++++++----- .../releasenotes/source/conf.py | 9 +++++++-- {{cookiecutter.repo_name}}/test-requirements.txt | 5 ++--- 3 files changed, 16 insertions(+), 10 deletions(-) diff --git a/{{cookiecutter.repo_name}}/doc/source/conf.py b/{{cookiecutter.repo_name}}/doc/source/conf.py index 51b5670..69bcbb1 100755 --- a/{{cookiecutter.repo_name}}/doc/source/conf.py +++ b/{{cookiecutter.repo_name}}/doc/source/conf.py @@ -15,8 +15,6 @@ import os import sys -import openstackdocstheme - sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ---------------------------------------------------- @@ -24,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', + 'openstackdocstheme', #'sphinx.ext.intersphinx', ] @@ -39,7 +38,12 @@ master_doc = 'index' # General information about the project. project = u'{{cookiecutter.repo_name}}' -copyright = u'2016, OpenStack Foundation' +copyright = u'2017, OpenStack Foundation' + +# openstackdocstheme options +repository_name = '{{cookiecutter.repo_group}}/{cookiecutter.repo_name}}' +bug_project = '{{cookiecutter.launchpad_project}}' +bug_tag = '' # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -60,8 +64,6 @@ pygments_style = 'sphinx' # html_static_path = ['static'] html_theme = 'openstackdocs' -html_theme_path = [openstackdocstheme.get_html_theme_path()] - # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/{{cookiecutter.repo_name}}/releasenotes/source/conf.py b/{{cookiecutter.repo_name}}/releasenotes/source/conf.py index 328542c..f7a45eb 100644 --- a/{{cookiecutter.repo_name}}/releasenotes/source/conf.py +++ b/{{cookiecutter.repo_name}}/releasenotes/source/conf.py @@ -38,7 +38,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -58,6 +58,11 @@ master_doc = 'index' project = u'{{cookiecutter.module_name}} Release Notes' copyright = u'2016, OpenStack Foundation' +# openstackdocstheme options +repository_name = '{{cookiecutter.repo_group}}/{cookiecutter.repo_name}}' +bug_project = '{{cookiecutter.launchpad_project}}' +bug_tag = '' + # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. @@ -111,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 diff --git a/{{cookiecutter.repo_name}}/test-requirements.txt b/{{cookiecutter.repo_name}}/test-requirements.txt index 0867f20..f559c0e 100644 --- a/{{cookiecutter.repo_name}}/test-requirements.txt +++ b/{{cookiecutter.repo_name}}/test-requirements.txt @@ -6,11 +6,10 @@ hacking>=0.12.0,<0.13 # Apache-2.0 coverage>=4.0,!=4.4 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD -sphinx!=1.6.1,>=1.5.1 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +sphinx>=1.6.2 # BSD oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=1.4.0 # MIT - +openstackdocstheme>=1.11.0 # Apache-2.0 # releasenotes reno>=1.8.0 # Apache-2.0