aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/index.rst
blob: f71801851bf3c073037e7010ceaa6ff4c23eafe9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
.. Chromebooks Test Suite documentation master file, created by
   sphinx-quickstart on Fri Dec 20 14:19:08 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:tocdepth: 3

####################################
Chromebooks Test Suite Documentation
####################################

The ``crostests`` package is a framework for fully automated testing. It is
designed primarily to test the Linux Kernel under KernelCI with the main focus
on Chromebooks devices.

``crostests`` is composed of a number of modules that will help you to do stand
alone tests or setup a fully automated test on KernelCI, depending on what you
are up to.

.. _getting-started:

***************
Getting Started
***************

.. toctree::
   :maxdepth: 1

   install

.. _user-docs:

******************
User Documentation
******************

.. toctree::
   :maxdepth: 1

   testcases
   testhelpers
   testrunners

.. _developer-docs:

***********************
Developer Documentation
***********************

The developer documentation contains instructions for how to contribute to
the Chromebook tests or affiliated packages, as well as coding, documentation,
and testing guidelines.

.. toctree::
   :maxdepth: 1

   development/testguide

.. _project-details:

***************
Project details
***************

.. toctree::
   :maxdepth: 1

   credits
   license

******************
Indices and tables
******************

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`