1028978 - Keep documentation on marionette test API's in readthedocs

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, defect)

Description

[William Lachance (:wlach)]

Currently we document the marionette client python api here:

http://marionette-client.readthedocs.org/en/latest/

It would be nice to keep the documentation on the API for writing marionette tests in readthedocs, essentially replacing the following:

https://developer.mozilla.org/en/Marionette/Marionette_Python_Tests
https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/MarionetteTestCase
https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/Marionette_Python_Tests

This probably involves splitting up the marionette documentation into two sections: Client API and Test API. Then move the current documentation into the client section and add a new test api section, which scans the python API stuff and describes how to use it. We might want to use the same pattern we did with mozbase where we have an index file that links to others (http://hg.mozilla.org/mozilla-central/file/31de1a84b27f/testing/mozbase/docs/index.rst)

This is a somewhat open ended task and I deliberately haven't filled in all the details because I'm not entirely sure what they are. :) Feel free to ask me, mdas, jgriffin, or automatedtester on irc #ateam if you have questions.

When this lands, we should also update this page (and some of its subpages) to point to the new information.

https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/Tests

Comment 1

[David Burns :automatedtester]

this is all done in my opinion, we have updated MDN to point at RTDs