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.
5
6mozbase
7=======
8
9Mozbase is a set of easy-to-use Python packages forming a supplemental standard
10library for Mozilla. It provides consistency and reduces redundancy in
11automation and other system-level software. All of Mozilla's test harnesses use
12mozbase to some degree, including Talos_, mochitest_, and reftest_.
13
14.. _Talos: https://wiki.mozilla.org/Talos
15
16.. _mochitest: https://developer.mozilla.org/en-US/docs/Mochitest
17
18.. _reftest: https://developer.mozilla.org/en-US/docs/Creating_reftest-based_unit_tests
19
20In the course of writing automated tests at Mozilla, we found that
21the same tasks came up over and over, regardless of the specific nature of
22what we were testing. We figured that consolidating this code into a set of
23libraries would save us a good deal of time, and so we spent some effort
24factoring out the best-of-breed automation code into something we named
25"mozbase" (usually written all in lower case except at the beginning of a
26sentence).
27
28This is the main documentation for users of mozbase. There is also a
29project_ wiki page with notes on development practices and administration.
30
31.. _project: https://wiki.mozilla.org/Auto-tools/Projects/Mozbase
32
33The documentation is organized by category, then by module. Figure out what you
34want to do then dive in!
35
36.. toctree::
37   :maxdepth: 2
38
39   manifestparser
40   gettinginfo
41   setuprunning
42   servingcontent
43   loggingreporting
44   devicemanagement
45