Closed
Bug 986719
Opened 11 years ago
Closed 11 years ago
Centralized documentation for UITelemetry
Categories
(Firefox for Android Graveyard :: General, defect)
Tracking
(Not tracked)
RESOLVED
FIXED
Firefox 31
People
(Reporter: rnewman, Assigned: rnewman)
References
Details
Attachments
(1 file)
(deleted),
patch
|
gps
:
review+
|
Details | Diff | Splinter Review |
We should have in-tree generated docs for the data we're producing. Now we have Bug 939367, we can do it!
This bug tracks creating the stub.
Comment 1•11 years ago
|
||
This is easy and awesome:
http://mxr.mozilla.org/mozilla-central/source/tools/docs/index.rst#30
One thing that's not obvious, though, is how to have documentation for the desktop and Fennec implementations of UITelemetry close to each other.
Assignee | ||
Updated•11 years ago
|
Assignee: nobody → rnewman
Status: NEW → ASSIGNED
Comment 2•11 years ago
|
||
The in-tree docs are considered not part of the build and they do crazy things like install 3rd party Python libraries from PyPI.
A brief search of the internets for "sphinx javadoc" reveals cool projects like http://bronto.github.io/javasphinx/ that allow you to incorporate javadoc output into Sphinx. I think adding javadocs to the output of |mach build-docs| would be a nifty feature!
Let me know if you'd like to pursue something more official for Java docs integration.
Comment 3•11 years ago
|
||
(In reply to Nick Alexander :nalexander from comment #1)
> This is easy and awesome:
>
> http://mxr.mozilla.org/mozilla-central/source/tools/docs/index.rst#30
>
> One thing that's not obvious, though, is how to have documentation for the
> desktop and Fennec implementations of UITelemetry close to each other.
See tools/docs.
We currently stage each "namespace" from SPHINX_TREES into a staging directory. We don't have a mechanism for combining files from multiple directories into the same destination. Should be possible with a small patch. Hardest part is looking for conflicts coming from multiple source directories. (We could probably use this feature for FHR as well.)
Assignee | ||
Comment 4•11 years ago
|
||
Step one: have *any* generated docs for Fennec. We can iterate later.
Assignee | ||
Comment 5•11 years ago
|
||
No content yet other than links. Individual UITelemetry work can add here.
Attachment #8395090 -
Flags: review?(gps)
Comment 6•11 years ago
|
||
Comment on attachment 8395090 [details] [diff] [review]
Centralized documentation for UITelemetry. v1
Review of attachment 8395090 [details] [diff] [review]:
-----------------------------------------------------------------
This is all you need!
Attachment #8395090 -
Flags: review?(gps) → review+
Assignee | ||
Comment 7•11 years ago
|
||
https://hg.mozilla.org/integration/fx-team/rev/e4b7ea863d20
Thanks for the quick turnaround, gps!
Target Milestone: --- → Firefox 31
Comment 8•11 years ago
|
||
Status: ASSIGNED → RESOLVED
Closed: 11 years ago
Resolution: --- → FIXED
Updated•4 years ago
|
Product: Firefox for Android → Firefox for Android Graveyard
You need to log in
before you can comment on or make changes to this bug.
Description
•