turn on warning-is-error in doc build

Change-Id: Id87a1b17c1986d0e30629fed13bdfbecef4a3603
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-07-08 14:18:39 -04:00
parent b0ca782396
commit 0c99c6d3c6
5 changed files with 8 additions and 5 deletions

View File

@ -99,6 +99,7 @@ universal = 1
source-dir = doc/source
build-dir = doc/build
all_files = 1
warning-is-error = 1
[upload_sphinx]
upload-dir = doc/build/html

View File

@ -211,7 +211,7 @@ class Atom(object):
method has a different signature from ``execute`` or
a different ``revert_rebind`` value was received.
:ivar inject: See parameter ``inject``.
:ivar name: See parameter ``name``.
:ivar Atom.name: See parameter ``name``.
:ivar requires: A :py:class:`~taskflow.types.sets.OrderedSet` of inputs
this atom requires to function.
:ivar optional: A :py:class:`~taskflow.types.sets.OrderedSet` of inputs

View File

@ -27,10 +27,12 @@ from taskflow.utils import misc
class Engine(object):
"""Base for all engines implementations.
:ivar notifier: A notification object that will dispatch events that
occur related to the flow the engine contains.
:ivar Engine.notifier: A notification object that will dispatch
events that occur related to the flow the engine
contains.
:ivar atom_notifier: A notification object that will dispatch events that
occur related to the atoms the engine contains.
"""
def __init__(self, flow, flow_detail, backend, options):

View File

@ -500,7 +500,7 @@ class AtomDetail(object):
``execute`` method or from other sources.
:ivar revert_results: Any results the atom produced from either its
``revert`` method or from other sources.
:ivar failure: If the atom failed (due to its ``execute`` method
:ivar AtomDetail.failure: If the atom failed (due to its ``execute`` method
raising) this will be a
:py:class:`~taskflow.types.failure.Failure` object that
represents that failure (if there was no failure this

View File

@ -21,7 +21,7 @@ class Entity(object):
:ivar kind: **immutable** type/kind that identifies this
entity (typically unique to a library/application)
:type kind: string
:ivar name: **immutable** name that can be used to uniquely
:ivar Entity.name: **immutable** name that can be used to uniquely
identify this entity among many other entities
:type name: string
:ivar metadata: **immutable** dictionary of metadata that is