Bug 1320099 - Move marionette_driver docs to testing/marionette/client. r=ato a=test-only
authorHenrik Skupin <mail@hskupin.info>
Fri, 25 Nov 2016 13:16:00 +0100
changeset 352693 6368a6a06b5fa4cd38b3c39157f80948575a8b62
parent 352692 ec1829beb55cfda53c7fda0610ad6f2ddc2537b7
child 352694 bb32677bad4c65780153a9a642067d9cae236190
push id6795
push userjlund@mozilla.com
push dateMon, 23 Jan 2017 14:19:46 +0000
treeherdermozilla-esr52@76101b503191 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersato, test-only
bugs1320099
milestone52.0a2
Bug 1320099 - Move marionette_driver docs to testing/marionette/client. r=ato a=test-only MozReview-Commit-ID: 7Bshw4H5yRT
testing/marionette/client/docs/Makefile
testing/marionette/client/docs/advanced/actions.rst
testing/marionette/client/docs/advanced/debug.rst
testing/marionette/client/docs/advanced/findelement.rst
testing/marionette/client/docs/advanced/landing.rst
testing/marionette/client/docs/advanced/stale.rst
testing/marionette/client/docs/basics.rst
testing/marionette/client/docs/conf.py
testing/marionette/client/docs/index.rst
testing/marionette/client/docs/interactive.rst
testing/marionette/client/docs/make.bat
testing/marionette/client/docs/reference.rst
testing/marionette/harness/docs/Makefile
testing/marionette/harness/docs/advanced/actions.rst
testing/marionette/harness/docs/advanced/debug.rst
testing/marionette/harness/docs/advanced/findelement.rst
testing/marionette/harness/docs/advanced/landing.rst
testing/marionette/harness/docs/advanced/stale.rst
testing/marionette/harness/docs/basics.rst
testing/marionette/harness/docs/conf.py
testing/marionette/harness/docs/index.rst
testing/marionette/harness/docs/interactive.rst
testing/marionette/harness/docs/make.bat
testing/marionette/harness/docs/reference.rst
rename from testing/marionette/harness/docs/Makefile
rename to testing/marionette/client/docs/Makefile
rename from testing/marionette/harness/docs/advanced/actions.rst
rename to testing/marionette/client/docs/advanced/actions.rst
rename from testing/marionette/harness/docs/advanced/debug.rst
rename to testing/marionette/client/docs/advanced/debug.rst
rename from testing/marionette/harness/docs/advanced/findelement.rst
rename to testing/marionette/client/docs/advanced/findelement.rst
rename from testing/marionette/harness/docs/advanced/landing.rst
rename to testing/marionette/client/docs/advanced/landing.rst
rename from testing/marionette/harness/docs/advanced/stale.rst
rename to testing/marionette/client/docs/advanced/stale.rst
rename from testing/marionette/harness/docs/basics.rst
rename to testing/marionette/client/docs/basics.rst
--- a/testing/marionette/harness/docs/basics.rst
+++ b/testing/marionette/client/docs/basics.rst
@@ -1,14 +1,14 @@
 .. py:currentmodule:: marionette_driver.marionette
 
 Marionette Python Client
 ========================
 
-The Marionette python client library allows you to remotely control a
+The Marionette Python client library allows you to remotely control a
 Gecko-based browser or device which is running a Marionette_
 server. This includes Firefox Desktop and Firefox for Android.
 
 The Marionette server is built directly into Gecko and can be started by
 passing in a command line option to Gecko, or by using a Marionette-enabled
 build. The server listens for connections from various clients. Clients can
 then control Gecko by sending commands to the server.
 
@@ -16,21 +16,21 @@ This is the official Python client for M
 `NodeJS client`_ maintained by the Firefox OS automation team.
 
 .. _Marionette: https://developer.mozilla.org/en-US/docs/Marionette
 .. _NodeJS client: https://github.com/mozilla-b2g/gaia/tree/master/tests/jsmarionette
 
 Getting the Client
 ------------------
 
-The python client is officially supported. To install it, first make sure you
+The Python client is officially supported. To install it, first make sure you
 have `pip installed`_ then run:
 
 .. parsed-literal::
-   pip install marionette_client
+   pip install marionette_driver
 
 It's highly recommended to use virtualenv_ when installing Marionette to avoid
 package conflicts and other general nastiness.
 
 You should now be ready to start using Marionette. The best way to learn is to
 play around with it. Start a `Marionette-enabled instance of Firefox`_, fire up
 a python shell and follow along with the
 :doc:`interactive tutorial <interactive>`!
@@ -49,16 +49,18 @@ testing with Marionette.
 
 Session Management
 ------------------
 A session is a single instance of a Marionette client connected to a Marionette
 server. Before you can start executing commands, you need to start a session
 with :func:`start_session() <Marionette.start_session>`:
 
 .. parsed-literal::
+   from marionette_driver.marionette import Marionette
+
    client = Marionette('localhost', port=2828)
    client.start_session()
 
 This returns a session id and an object listing the capabilities of the
 Marionette server. For example, a server running on Firefox Desktop will
 have some features which a server running from Firefox Android won't.
 It's also possible to access the capabilities using the
 :attr:`~Marionette.session_capabilities` attribute. After finishing with a
rename from testing/marionette/harness/docs/conf.py
rename to testing/marionette/client/docs/conf.py
rename from testing/marionette/harness/docs/index.rst
rename to testing/marionette/client/docs/index.rst
rename from testing/marionette/harness/docs/interactive.rst
rename to testing/marionette/client/docs/interactive.rst
rename from testing/marionette/harness/docs/make.bat
rename to testing/marionette/client/docs/make.bat
rename from testing/marionette/harness/docs/reference.rst
rename to testing/marionette/client/docs/reference.rst