Skip to content

Commit 611049e

Browse files
amiclauscseci
amiclaus
authored and
cseci
committed
Update documentation to bf1043a 
0 parents  commit 611049e

File tree

35,439 files changed

+2978423
-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.

35,439 files changed

+2978423
-0
lines changed

‎.nojekyll

Whitespace-only changes.

‎_sources/contributing.rst.txt

+38
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/ad405x.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/adc/ad405x/README.rst

‎_sources/drivers/ad5293.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/potentiometer/ad5293/README.rst

‎_sources/drivers/ad796x.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/adc/ad796x/README.rst

‎_sources/drivers/ad8460.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/dac/ad8460/README.rst

‎_sources/drivers/ade7816.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/meter/ade7816/README.rst

‎_sources/drivers/adf4368.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/frequency/adf4368/README.rst

‎_sources/drivers/adf4382.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/frequency/adf4382/README.rst

‎_sources/drivers/adf5611.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/frequency/adf5611/README.rst

‎_sources/drivers/adm1177.rst.txt

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

‎_sources/drivers/adp1050.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/power/adp1050/README.rst

‎_sources/drivers/adxl355.rst.txt

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

‎_sources/drivers/axi_sysid.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/axi_core/axi_sysid/README.rst

‎_sources/drivers/imu.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/imu/README.rst

‎_sources/drivers/lt7170.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/power/lt7170/README.rst

‎_sources/drivers/lt7182s.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/power/lt7182s/README.rst

‎_sources/drivers/lt8491.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/power/lt8491/README.rst

‎_sources/drivers/lt8722.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/power/lt8722/README.rst

‎_sources/drivers/ltc2983.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/temperature/ltc2983/README.rst

‎_sources/drivers/ltc2992.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/power/ltc2992/README.rst

‎_sources/drivers/ltc4162l.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/power/ltc4162l/README.rst

‎_sources/drivers/ltc4296.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/power/ltc4296/README.rst

‎_sources/drivers/ltm4686.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/power/ltm4686/README.rst

‎_sources/drivers/ltp8800.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/power/ltp8800/README.rst

‎_sources/drivers/madura.rst.txt

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

‎_sources/drivers/max14914.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/digital-io/max14914/README.rst

‎_sources/drivers/max14919.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/digital-io/max14919/README.rst

‎_sources/drivers/max149x6.rst.txt

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

‎_sources/drivers/max22017.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/dac/max22017/README.rst

‎_sources/drivers/max22190.rst.txt

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

‎_sources/drivers/max22196.rst.txt

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

‎_sources/drivers/max22200.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/digital-io/max22200/README.rst

‎_sources/drivers/max25603.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/led/max25603/README.rst

‎_sources/drivers/max31827.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/temperature/max31827/README.rst

‎_sources/drivers/max42500.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/power/max42500/README.rst

‎_sources/drivers/pulsar_adc.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../drivers/adc/pulsar_adc/README.rst

‎_sources/drivers_doc.rst.txt

+118
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
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+
drivers/ad405x
21+
drivers/ad796x
22+
drivers/pulsar_adc
23+
24+
AXI CORES
25+
=========
26+
.. toctree::
27+
:maxdepth: 1
28+
29+
drivers/axi_sysid
30+
31+
DIGITAL INPUT/OUTPUT
32+
==========================
33+
.. toctree::
34+
:maxdepth: 1
35+
36+
drivers/max14914
37+
drivers/max14919
38+
drivers/max149x6
39+
drivers/max22190
40+
drivers/max22196
41+
drivers/max22200
42+
43+
DIGITAL TO ANALOG CONVERTERS
44+
============================
45+
.. toctree::
46+
:maxdepth: 1
47+
48+
drivers/ad8460
49+
drivers/max22017
50+
51+
FREQUENCY GENERATORS
52+
====================
53+
.. toctree::
54+
:maxdepth: 1
55+
56+
drivers/adf4382
57+
drivers/adf4368
58+
drivers/adf5611
59+
60+
INERTIAL MEASUREMENT UNITS
61+
==========================
62+
.. toctree::
63+
:maxdepth: 1
64+
65+
drivers/imu
66+
67+
LED
68+
===
69+
.. toctree::
70+
:maxdepth: 1
71+
72+
drivers/max25603
73+
74+
METER
75+
=====
76+
.. toctree::
77+
:maxdepth: 1
78+
79+
drivers/ade7816
80+
81+
RF TRANSCEIVER
82+
==============
83+
.. toctree::
84+
:maxdepth: 1
85+
86+
drivers/madura
87+
88+
TEMPERATURE
89+
==============
90+
.. toctree::
91+
:maxdepth: 1
92+
93+
drivers/max31827
94+
drivers/ltc2983
95+
96+
POWER MANAGEMENT
97+
================
98+
.. toctree::
99+
:maxdepth: 1
100+
101+
drivers/adp1050
102+
drivers/ltc2992
103+
drivers/ltc4162l
104+
drivers/ltc4296
105+
drivers/ltm4686
106+
drivers/lt7170
107+
drivers/lt7182s
108+
drivers/lt8491
109+
drivers/lt8722
110+
drivers/ltp8800
111+
drivers/max42500
112+
113+
POTENTIOMETER
114+
================
115+
.. toctree::
116+
:maxdepth: 1
117+
118+
drivers/ad5293

0 commit comments

Comments
 (0)