mirror of
https://github.com/ARM-software/devlib.git
synced 2024-10-06 02:40:50 +01:00
ec0a5884c0
Update the documentation to indicated which module each class is located. This allows the documentation to be referenced from other modules as well as enabling links to the source code directly from the documentation.
36 lines
756 B
ReStructuredText
36 lines
756 B
ReStructuredText
.. devlib documentation master file, created by
|
|
sphinx-quickstart on Tue Aug 11 17:37:27 2015.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
.. module:: devlib
|
|
|
|
Welcome to devlib documentation
|
|
===============================
|
|
|
|
devlib provides an interface for interacting with remote targets, such as
|
|
development boards, mobile devices, etc. It also provides means of collecting
|
|
various measurements and traces from such targets.
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
overview
|
|
target
|
|
modules
|
|
instrumentation
|
|
collectors
|
|
derived_measurements
|
|
platform
|
|
connection
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|