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