by running the command tox -edocs, I have this warnings :
tox -edocs
docs create: /home/dtardivel/bcom/OPENSTACK/watcher/.tox/docs
docs installdeps: -r/home/dtardivel/bcom/OPENSTACK/watcher/requirements.txt, -r/home/dtardivel/bcom/OPENSTACK/watcher/test-requirements.txt
docs develop-inst: /home/dtardivel/bcom/OPENSTACK/watcher
docs runtests: commands[0] | python setup.py build_sphinx
running build_sphinx
[pbr] Writing ChangeLog
[pbr] Generating ChangeLog
[pbr] ChangeLog complete (0.0s)
[pbr] Generating AUTHORS
[pbr] AUTHORS complete (0.0s)
...
======================
Contributing to Watcher
======================
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/dev/plugins.rst:70: WARNING: autodoc: failed to import class u'BaseStrategy' from module u'watcher.decision_engine.api.strategy.strategy'; the following exception was raised:
Traceback (most recent call last):
File "/home/dtardivel/bcom/OPENSTACK/watcher/.tox/docs/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 342, in import_object
obj = self.get_attr(obj, part)
File "/home/dtardivel/bcom/OPENSTACK/watcher/.tox/docs/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 241, in get_attr
return safe_getattr(obj, name, *defargs)
File "/home/dtardivel/bcom/OPENSTACK/watcher/.tox/docs/local/lib/python2.7/site-packages/sphinx/util/inspect.py", line 114, in safe_getattr
raise AttributeError(name)
AttributeError: BaseStrategy
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/webapi/v1.rst:11: WARNING: Field list ends without a blank line; unexpected unindent.
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/webapi/v1.rst:62: WARNING: Field list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/configuration.rst:: WARNING: document isn't included in any toctree
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/readme.rst:: WARNING: document isn't included in any toctree
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/usage.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] webapi/v1
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:38: WARNING: undefined label: audit_template_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:38: WARNING: undefined label: audit_template_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:38: WARNING: undefined label: goal_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:51: WARNING: undefined label: goal_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:54: WARNING: undefined label: audit_template_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:58: WARNING: undefined label: audit_template_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:64: WARNING: undefined label: audit_template_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:72: WARNING: undefined label: action_plan_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:72: WARNING: undefined label: action_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:72: WARNING: undefined label: goal_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:79: WARNING: undefined label: action_plan_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:86: WARNING: undefined label: action_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:87: WARNING: undefined label: action_plan_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:94: WARNING: undefined label: action_plan_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:98: WARNING: undefined label: action_plan_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/deploy/user-guide.rst:104: WARNING: undefined label: action_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/dev/plugins.rst:8: WARNING: undefined label: strategy_definition (if the link has no caption the label must precede a section header)
/home/dtardivel/bcom/OPENSTACK/watcher/doc/source/dev/plugins.rst:8: WARNING: undefined label: strategy_definition (if the link has no caption the label must precede a section header)
writing additional files... (0 module code pages) genindex http-routingtable search
...
Reviewed: https:/ /review. openstack. org/252480 /git.openstack. org/cgit/ openstack/ watcher/ commit/ ?id=f555e66d751 2651756dce24cc9 600512f19188f3
Committed: https:/
Submitter: Jenkins
Branch: master
commit f555e66d7512651 756dce24cc96005 12f19188f3
Author: Vincent Françoise <email address hidden>
Date: Wed Dec 2 16:55:08 2015 +0100
Fixed doc generation warning
The BaseStrategy interface was moved to another location but the
documentation wasn't updated accordingly, so here I updated this
import path.
As an extra, I also updated the description of the Solution which
also had an outdated import path.
Closes-Bug: #1522034 391db06ec6dfe82 ce02eccc7f4
Change-Id: I8cd43e84db6945