Create sphinx documentation and a readthedocs page for mozillapulse

NEW
Unassigned

Status

5 years ago
5 years ago

People

(Reporter: ahal, Unassigned)

Tracking

Trunk
Points:
---

Firefox Tracking Flags

(Not tracked)

Details

(Reporter)

Description

5 years ago
I've found it difficult to figure out how to properly use the mozillapulse package, usually resorting to reading the source to figure it out. Even examples of other programs using it are hard to come by.

I think a simple readthedocs page with example usage for some of the most common scenarios would go a long way.
(Reporter)

Comment 1

5 years ago
Talked to mcote a bit on irc. I guess a readthedocs page isn't entirely necessary. Basically I'd be happy if we had concrete examples:

"Here's how to get messages from test jobs in treeherder..."
"Here's how to get bugzilla updates..."
"Here's how to get taskcluster notifications..."

Adding some of these to the wiki page would be good enough for me. Though I think API docs could still be useful.
You need to log in before you can comment on or make changes to this bug.