1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/testing/mozbase/docs/index.rst Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,57 @@
1.4 +.. MozBase documentation master file, created by
1.5 + sphinx-quickstart on Mon Oct 22 14:02:17 2012.
1.6 + You can adapt this file completely to your liking, but it should at least
1.7 + contain the root `toctree` directive.
1.8 +
1.9 +mozbase
1.10 +=======
1.11 +
1.12 +Mozbase is a set of easy-to-use Python packages forming a supplemental standard
1.13 +library for Mozilla. It provides consistency and reduces redundancy in
1.14 +automation and other system-level software. All of Mozilla's test harnesses use
1.15 +mozbase to some degree, including Talos_, mochitest_, reftest_, Autophone_, and
1.16 +Eideticker_.
1.17 +
1.18 +.. _Talos: https://wiki.mozilla.org/Talos
1.19 +
1.20 +.. _mochitest: https://developer.mozilla.org/en-US/docs/Mochitest
1.21 +
1.22 +.. _reftest: https://developer.mozilla.org/en-US/docs/Creating_reftest-based_unit_tests
1.23 +
1.24 +.. _Autophone: https://wiki.mozilla.org/Auto-tools/Projects/AutoPhone
1.25 +
1.26 +.. _Eideticker: https://wiki.mozilla.org/Project_Eideticker
1.27 +
1.28 +In the course of writing automated tests at Mozilla, we found that
1.29 +the same tasks came up over and over, regardless of the specific nature of
1.30 +what we were testing. We figured that consolidating this code into a set of
1.31 +libraries would save us a good deal of time, and so we spent some effort
1.32 +factoring out the best-of-breed automation code into something we named
1.33 +"mozbase" (usually written all in lower case except at the beginning of a
1.34 +sentence).
1.35 +
1.36 +This is the main documentation for users of mozbase. There is also a
1.37 +project_ wiki page with notes on development practices and administration.
1.38 +
1.39 +.. _project: https://wiki.mozilla.org/Auto-tools/Projects/Mozbase
1.40 +
1.41 +The documentation is organized by category, then by module. Figure out what you
1.42 +want to do then dive in!
1.43 +
1.44 +.. toctree::
1.45 + :maxdepth: 2
1.46 +
1.47 + manifestdestiny
1.48 + gettinginfo
1.49 + setuprunning
1.50 + mozhttpd
1.51 + loggingreporting
1.52 + devicemanagement
1.53 +
1.54 +Indices and tables
1.55 +==================
1.56 +
1.57 +* :ref:`genindex`
1.58 +* :ref:`modindex`
1.59 +* :ref:`search`
1.60 +
