Skip to content

Commit 91bdcfa

Browse files
amiclauscseci
amiclaus
authored and
cseci
committed
Update documentation to 03696d4 
0 parents  commit 91bdcfa

File tree

24,527 files changed

+2158877
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

24,527 files changed

+2158877
-0
lines changed

‎.nojekyll

Whitespace-only changes.

‎_sources/contributing.rst.txt

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
*********************
2+
Contributing to no-OS
3+
*********************
4+
5+
Fork and pull request workflow
6+
==============================
7+
8+
When you don't have write permissions to the **no-OS** repository, the
9+
**fork and pull request** workflow can be used.
10+
11+
More details: `GitHub Quickstart: Contributing to projects
12+
<https://docs.github.com/en/get-started/quickstart/contributing-to-projects>`_.
13+
14+
Once a pull request is opened, select the **analogdevicesinc/noos** team as a
15+
reviewer. The changes should be approved by at least one no-OS maintainer
16+
before they can be merged to the base brach.
17+
18+
Submission Checklist
19+
====================
20+
21+
Before being reviewed by the no-OS maintainers and then accepted to the GitHub
22+
repository, each commit should respect a few rules:
23+
24+
- The commit contains a **Signed-off-by** trailer by the committer at the end
25+
of the commit log message - it certifies that the committer has the rights to
26+
submit the work under the project's license.
27+
28+
- If built using **gcc**, options such as **-Wall** and **-Wextra** don't
29+
detect any issues with the commit. When the pull request is created, drivers
30+
and project build are automatically triggered.
31+
32+
- **astyle --style=linux --indent=force-tab=8 --max-code-length=80** doesn't
33+
detect any issue with the commit.
34+
35+
- A detailed description of how the new changes were tested is provided. This
36+
information can be written in the pull request description. If the driver
37+
was tested on one of the supported no-OS platforms, it is recommended to also
38+
add a project example which uses the newly added driver.

‎_sources/drivers/adm1177.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/adc/adm1177/README.rst

‎_sources/drivers/adxl355.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/accel/adxl355/README.rst

‎_sources/drivers/imu.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/imu/README.rst

‎_sources/drivers/madura.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/rf-transceiver/madura/README.rst

‎_sources/drivers/max149x6.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/digital-io/max149x6/README.rst

‎_sources/drivers/max22190.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/digital-io/max22190/README.rst

‎_sources/drivers/max22196.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/digital-io/max22196/README.rst

‎_sources/drivers_doc.rst.txt

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
******************
2+
no-OS drivers list
3+
******************
4+
5+
The following sections contain code documentation for ADI no-OS drivers.
6+
7+
ACCELEROMETERS
8+
==============
9+
.. toctree::
10+
:maxdepth: 1
11+
12+
drivers/adxl355
13+
14+
ANALOG TO DIGITAL CONVERTERS
15+
============================
16+
.. toctree::
17+
:maxdepth: 1
18+
19+
drivers/adm1177
20+
21+
DIGITAL INPUT/OUTPUT
22+
==========================
23+
.. toctree::
24+
:maxdepth: 1
25+
26+
drivers/max149x6
27+
drivers/max22190
28+
drivers/max22196
29+
30+
INERTIAL MEASUREMENT UNITS
31+
==========================
32+
.. toctree::
33+
:maxdepth: 1
34+
35+
drivers/imu
36+
37+
RF TRANSCEIVER
38+
==============
39+
.. toctree::
40+
:maxdepth: 1
41+
42+
drivers/madura

0 commit comments

Comments
 (0)