testing/mozbase/docs/index.rst

Wed, 31 Dec 2014 06:09:35 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 06:09:35 +0100
changeset 0
6474c204b198
permissions
-rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

     1 .. MozBase documentation master file, created by
     2    sphinx-quickstart on Mon Oct 22 14:02:17 2012.
     3    You can adapt this file completely to your liking, but it should at least
     4    contain the root `toctree` directive.
     6 mozbase
     7 =======
     9 Mozbase is a set of easy-to-use Python packages forming a supplemental standard
    10 library for Mozilla. It provides consistency and reduces redundancy in
    11 automation and other system-level software. All of Mozilla's test harnesses use
    12 mozbase to some degree, including Talos_, mochitest_, reftest_, Autophone_, and
    13 Eideticker_.
    15 .. _Talos: https://wiki.mozilla.org/Talos
    17 .. _mochitest: https://developer.mozilla.org/en-US/docs/Mochitest
    19 .. _reftest: https://developer.mozilla.org/en-US/docs/Creating_reftest-based_unit_tests
    21 .. _Autophone: https://wiki.mozilla.org/Auto-tools/Projects/AutoPhone
    23 .. _Eideticker: https://wiki.mozilla.org/Project_Eideticker
    25 In the course of writing automated tests at Mozilla, we found that
    26 the same tasks came up over and over, regardless of the specific nature of
    27 what we were testing. We figured that consolidating this code into a set of
    28 libraries would save us a good deal of time, and so we spent some effort
    29 factoring out the best-of-breed automation code into something we named
    30 "mozbase" (usually written all in lower case except at the beginning of a
    31 sentence).
    33 This is the main documentation for users of mozbase. There is also a
    34 project_ wiki page with notes on development practices and administration.
    36 .. _project: https://wiki.mozilla.org/Auto-tools/Projects/Mozbase
    38 The documentation is organized by category, then by module. Figure out what you
    39 want to do then dive in!
    41 .. toctree::
    42    :maxdepth: 2
    44    manifestdestiny
    45    gettinginfo
    46    setuprunning
    47    mozhttpd
    48    loggingreporting
    49    devicemanagement
    51 Indices and tables
    52 ==================
    54 * :ref:`genindex`
    55 * :ref:`modindex`
    56 * :ref:`search`

mercurial