Closed Bug 956803 Opened 9 years ago Closed 9 years ago

Doc autogeneration busted

Categories

(Testing :: Marionette, defect)

x86_64
Linux
defect
Not set
normal

Tracking

(b2g-v1.3 fixed)

RESOLVED FIXED
mozilla29
Tracking Status
b2g-v1.3 --- fixed

People

(Reporter: wlach, Assigned: wlach)

Details

Attachments

(1 file, 2 obsolete files)

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.
Attached patch marionette-docs.patch (obsolete) — Splinter Review
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
Assignee: nobody → wlachance
Attachment #8360214 - Flags: review?(mdas)
Move requirements.txt so we don't have to maintain two lists.
Attachment #8360214 - Attachment is obsolete: true
Attachment #8360214 - Flags: review?(mdas)
Attachment #8360223 - Flags: review?(wlachance)
Comment on attachment 8360223 [details] [diff] [review]
use requirements.txt in marionette client

LGTM!
Attachment #8360223 - Flags: review?(wlachance) → review+
add requirements.txt file to patch. carrying r+ forward
Attachment #8360223 - Attachment is obsolete: true
Attachment #8360226 - Flags: review+
https://hg.mozilla.org/mozilla-central/rev/4aa16429a2ca
Status: NEW → RESOLVED
Closed: 9 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla29
Looks like doc autogeneration is still broken but I think the problems are in/with readthedocs, not m-c now. Working on it.
You need to log in before you can comment on or make changes to this bug.