From 2f192796da99bec90baa8c5b82f57b88ed373550 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 21 Jul 2017 14:52:43 -0400 Subject: [PATCH] turn on warning-is-error Sphinx warns because the type of the copyright value is not a string, and with the flag on that prevents the build from proceeding. I tried using rst_epilog to add the text about where to contribute patches to the bottom of each page, but the result makes it seem like it is part of the text of the page. I think we want to add this as a feature to the theme, to show up just like we do with the report-a-bug link in the footer, so this patch removes the info under the assumption that it will be handled by the theme. Change-Id: Ia3e15b20a9d8a9e3598592b39dde316611c9323c Signed-off-by: Doug Hellmann --- doc/source/conf.py | 7 +------ setup.cfg | 1 + 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 1b75eba..ac20bcc 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -15,8 +15,6 @@ import datetime import sys import os -from jinja2.utils import Markup - # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -57,10 +55,7 @@ master_doc = 'index' # General information about the project. project = u'OpenStack Project Team Guide' -copyright = Markup(u'%s, OpenStack Contributors ' - u'- use the project-team-guide git repo ' - u'to propose changes' % datetime.date.today().year) +copyright = 'OpenStack Contributors' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/setup.cfg b/setup.cfg index d3440ee..2e55e94 100644 --- a/setup.cfg +++ b/setup.cfg @@ -15,6 +15,7 @@ classifier = all_files = 1 build-dir = doc/build source-dir = doc/source +warning-is-error = 1 [pbr] warnerrors = True