925137 - initial slaveapi documentation

Status: RESOLVED FIXED

(Release Engineering :: General, defect)

Description

[[e-mail] (:bhearsum)]

SlaveAPI has no documentation on how to use it. We need some!

Comment 1

[[e-mail] (:bhearsum)]

Attachment: better docstrings + sphinx for html generation

I've got the output from the 'make html' step hosted at https://people.mozilla.org/~bhearsum/slaveapi-docs/ until I can find a better place.

Comment 2

[[e-mail] (:bhearsum)]

16:38 < Callek> ahhh -- fwiw a few webdevy projects use readthedocs.org for its work, perhaps thats a good venue for hosting slaveapi rather than people
16:38  * Callek has no strong preference just a suggestion-if-it-suits
16:39 < dustin> rtfd++
16:39 < dustin> they host buildbot's docs too
16:40 <@bhearsum> ah, good idea
16:40  * bhearsum makes a note of that

Comment 3

[[e-mail] (:bhearsum)]

I moved the docs to http://mozilla-slaveapi.readthedocs.org/en/latest/, which is pointed at my user repository until this lands.

Comment 4

[John Hopkins (:jhopkins)]

Comment on attachment 815996 [details] [diff] [review]
better docstrings + sphinx for html generation

$ make html SPHINXBUILD=/opt/local/bin/sphinx-build-2.7
...
build succeeded, 5 warnings.

Comment 5

[[e-mail] (:bhearsum)]

Comment on attachment 815996 [details] [diff] [review]
better docstrings + sphinx for html generation

Pushed and repointed the readthedocs project at https://git.mozilla.org/build/slaveapi.git.