index.rst (1638B)
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 6 mozbase 7 ======= 8 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_, 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 20 In the course of writing automated tests at Mozilla, we found that 21 the same tasks came up over and over, regardless of the specific nature of 22 what we were testing. We figured that consolidating this code into a set of 23 libraries would save us a good deal of time, and so we spent some effort 24 factoring 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 26 sentence). 27 28 This is the main documentation for users of mozbase. There is also a 29 project_ wiki page with notes on development practices and administration. 30 31 .. _project: https://wiki.mozilla.org/Auto-tools/Projects/Mozbase 32 33 The documentation is organized by category, then by module. Figure out what you 34 want to do then dive in! 35 36 .. toctree:: 37 :maxdepth: 2 38 39 manifestparser 40 gettinginfo 41 setuprunning 42 servingcontent 43 loggingreporting 44 devicemanagement