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