956803 - Doc autogeneration busted

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, defect)

Description

[William Lachance (:wlach)]

Seeing this in recent builds (from the readthedocs admin console):

Running Sphinx v1.1.3
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] index
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/marionette_client/envs/latest/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 326, in import_object
    obj = self.get_attr(obj, part)
  File "/home/docs/checkouts/readthedocs.org/user_builds/marionette_client/envs/latest/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 232, in get_attr
    return safe_getattr(obj, name, *defargs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/marionette_client/envs/latest/local/lib/python2.7/site-packages/sphinx/util/inspect.py", line 70, in safe_getattr
    raise AttributeError(name)
AttributeError: DateTimeValue
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/marionette_client/envs/latest/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 326, in import_object
    obj = self.get_attr(obj, part)
  File "/home/docs/checkouts/readthedocs.org/user_builds/marionette_client/envs/latest/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 232, in get_attr
    return safe_getattr(obj, name, *defargs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/marionette_client/envs/latest/local/lib/python2.7/site-packages/sphinx/util/inspect.py", line 70, in safe_getattr
    raise AttributeError(name)
AttributeError: DateTimeValue
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/marionette_client/envs/latest/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 326, in import_object
    obj = self.get_attr(obj, part)
  File "/home/docs/checkouts/readthedocs.org/user_builds/marionette_client/envs/latest/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 232, in get_attr
    return safe_getattr(obj, name, *defargs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/marionette_client/envs/latest/local/lib/python2.7/site-packages/sphinx/util/inspect.py", line 70, in safe_getattr
    raise AttributeError(name)
AttributeError: DateTimeValue

This problem means that the docs aren't updating properly, so we're stuck with an old version. We should fix that.

Comment 1

[William Lachance (:wlach)]

Attachment: marionette-docs.patch

Ok, two problems that I could see:

* Marionette depends on moztest, so that should be in the requirements.txt for generating the virtualenv that we're using.
* We need to import DateTimeValue to look things up in the docs. I think this is something we probably generally want as part of the marionette namespace, so I added it to the objects we import from __init__.py

Comment 2

[Malini Das [:mdas] - Away, not checking bugmail]

Attachment: use requirements.txt in marionette client

Move requirements.txt so we don't have to maintain two lists.

Comment 3

[William Lachance (:wlach)]

Comment on attachment 8360223 [details] [diff] [review]
use requirements.txt in marionette client

LGTM!

Comment 4

[Malini Das [:mdas] - Away, not checking bugmail]

Attachment: use requirements.txt in marionette client

add requirements.txt file to patch. carrying r+ forward

Comment 5

[Malini Das [:mdas] - Away, not checking bugmail]

landed in m-i:
https://hg.mozilla.org/integration/mozilla-inbound/rev/4aa16429a2ca

Comment 6

[Ed Morley [:emorley]]

https://hg.mozilla.org/mozilla-central/rev/4aa16429a2ca

Comment 7

[William Lachance (:wlach)]

Looks like doc autogeneration is still broken but I think the problems are in/with readthedocs, not m-c now. Working on it.