warnings on generation of HTML doc

Bug #1522034 reported by David TARDIVEL on 2015-12-02
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
watcher
Medium
David TARDIVEL

Bug Description

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

...

Tags: doc Edit Tag help
Changed in watcher:
assignee: nobody → Vincent Françoise (vincent-francoise)
importance: Undecided → Medium

Reviewed: https://review.openstack.org/252480
Committed: https://git.openstack.org/cgit/openstack/watcher/commit/?id=f555e66d7512651756dce24cc9600512f19188f3
Submitter: Jenkins
Branch: master

commit f555e66d7512651756dce24cc9600512f19188f3
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
    Change-Id: I8cd43e84db6945391db06ec6dfe82ce02eccc7f4

Changed in watcher:
status: New → Fix Committed
Changed in watcher:
milestone: none → mitaka-2
tags: added: doc
Changed in watcher:
status: Fix Committed → In Progress
assignee: Vincent Françoise (vincent-francoise) → David TARDIVEL (david-tardivel)

Reviewed: https://review.openstack.org/268006
Committed: https://git.openstack.org/cgit/openstack/watcher/commit/?id=c8110513510cc4d71fc877e34a481c95006c6c27
Submitter: Jenkins
Branch: master

commit c8110513510cc4d71fc877e34a481c95006c6c27
Author: David TARDIVEL <email address hidden>
Date: Fri Jan 15 09:22:25 2016 +0100

    Fix Warnings generated while building of HTML docu

    Same ID have been set to reference different RST blocks.
    To avoid this, I added the prefix 'archi_' within ID referencing
    architecture RST block.

    Bad indentation warnings have been fixed.

    Change-Id: I17f43f2f564ffd83fd5c345aed96fad06ee56b1d
    Partial-Bug: #1522034

Changed in watcher:
status: In Progress → Fix Committed
Changed in watcher:
status: Fix Committed → In Progress

Reviewed: https://review.openstack.org/271996
Committed: https://git.openstack.org/cgit/openstack/watcher/commit/?id=6ff4ba991e5f16c57fd5b86b19b37d338b49d45b
Submitter: Jenkins
Branch: master

commit 6ff4ba991e5f16c57fd5b86b19b37d338b49d45b
Author: David TARDIVEL <email address hidden>
Date: Mon Jan 25 11:14:32 2016 +0100

    Fix HTML warnings on HTML doc

    Some cros-references were broken. This pathset fixes them.

    Change-Id: Iddd5df6cffb85258582c5571ce541a27467bea35
    Closes-Bug: #1522034

Changed in watcher:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers