Sylvestre Ledru
8f033c8241
Convert testing/{awsy,condprofile,docs,geckodriver,marionette,
mozbase,mozharness,perfdocs,performance,raptor,talos,web-platform}
RST documentation files to MyST-flavored Markdown.
Skips testing/perfdocs/generated/* (auto-generated by mach perfdocs)
and testing/web-platform/tests/* (third-party test trees).
- Move treeherder-try frontmatter substitutions under the new myst
topmatter key.
- Allow the pre-existing autodoc Unknown target warning for
mozprofile.permissions to keep the build clean.
- Refresh allowed-warnings glob for manifest-sandbox download from
.rst to .md.
Differential Revision: https://phabricator.services.mozilla.com/D304228
42 lines
1.6 KiB
Markdown
42 lines
1.6 KiB
Markdown
% MozBase documentation master file, created by
|
|
% sphinx-quickstart on Mon Oct 22 14:02:17 2012.
|
|
% You can adapt this file completely to your liking, but it should at least
|
|
% contain the root `toctree` directive.
|
|
|
|
# mozbase
|
|
|
|
Mozbase is a set of easy-to-use Python packages forming a supplemental standard
|
|
library for Mozilla. It provides consistency and reduces redundancy in
|
|
automation and other system-level software. All of Mozilla's test harnesses use
|
|
mozbase to some degree, including [Talos], [mochitest], and [reftest].
|
|
|
|
In the course of writing automated tests at Mozilla, we found that
|
|
the same tasks came up over and over, regardless of the specific nature of
|
|
what we were testing. We figured that consolidating this code into a set of
|
|
libraries would save us a good deal of time, and so we spent some effort
|
|
factoring out the best-of-breed automation code into something we named
|
|
"mozbase" (usually written all in lower case except at the beginning of a
|
|
sentence).
|
|
|
|
This is the main documentation for users of mozbase. There is also a
|
|
[project] wiki page with notes on development practices and administration.
|
|
|
|
The documentation is organized by category, then by module. Figure out what you
|
|
want to do then dive in!
|
|
|
|
```{toctree}
|
|
:maxdepth: 2
|
|
|
|
manifestparser
|
|
gettinginfo
|
|
setuprunning
|
|
servingcontent
|
|
loggingreporting
|
|
devicemanagement
|
|
```
|
|
|
|
[mochitest]: https://developer.mozilla.org/en-US/docs/Mochitest
|
|
[project]: https://wiki.mozilla.org/Auto-tools/Projects/Mozbase
|
|
[reftest]: https://developer.mozilla.org/en-US/docs/Creating_reftest-based_unit_tests
|
|
[talos]: https://wiki.mozilla.org/Talos
|