Skip to content

Commit

Permalink
Update documentation to addffab
Browse files Browse the repository at this point in the history
  • Loading branch information
@amiclaus @cseci
amiclaus authored and cseci committed Dec 3, 2024
0 parents commit d5251ef
Show file tree
Hide file tree
Showing 33,960 changed files with 2,833,906 additions and 0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
Empty file added .nojekyll
Empty file.
38 changes: 38 additions & 0 deletions _sources/contributing.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
*********************
Contributing to no-OS
*********************

Fork and pull request workflow
==============================

When you don't have write permissions to the **no-OS** repository, the
**fork and pull request** workflow can be used.

More details: `GitHub Quickstart: Contributing to projects
<https://docs.github.com/en/get-started/quickstart/contributing-to-projects>`_.

Once a pull request is opened, select the **analogdevicesinc/noos** team as a
reviewer. The changes should be approved by at least one no-OS maintainer
before they can be merged to the base brach.

Submission Checklist
====================

Before being reviewed by the no-OS maintainers and then accepted to the GitHub
repository, each commit should respect a few rules:

- The commit contains a **Signed-off-by** trailer by the committer at the end
of the commit log message - it certifies that the committer has the rights to
submit the work under the project's license.

- If built using **gcc**, options such as **-Wall** and **-Wextra** don't
detect any issues with the commit. When the pull request is created, drivers
and project build are automatically triggered.

- **astyle --style=linux --indent=force-tab=8 --max-code-length=80** doesn't
detect any issue with the commit.

- A detailed description of how the new changes were tested is provided. This
information can be written in the pull request description. If the driver
was tested on one of the supported no-OS platforms, it is recommended to also
add a project example which uses the newly added driver.
1 change: 1 addition & 0 deletions _sources/drivers/ad405x.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/adc/ad405x/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/ad5293.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/potentiometer/ad5293/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/ad796x.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/adc/ad796x/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/ade7816.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/meter/ade7816/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/adf4382.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/frequency/adf4382/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/adm1177.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/adc/adm1177/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/adp1050.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/power/adp1050/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/adxl355.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/accel/adxl355/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/axi_sysid.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/axi_core/axi_sysid/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/imu.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/imu/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/lt7170.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/power/lt7170/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/lt7182s.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/power/lt7182s/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/lt8491.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/power/lt8491/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/lt8722.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/power/lt8722/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/ltc2983.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/temperature/ltc2983/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/ltc2992.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/power/ltc2992/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/ltc4296.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/power/ltc4296/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/ltp8800.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/power/ltp8800/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/madura.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/rf-transceiver/madura/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/max14914.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/digital-io/max14914/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/max14919.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/digital-io/max14919/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/max149x6.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/digital-io/max149x6/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/max22017.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/dac/max22017/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/max22190.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/digital-io/max22190/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/max22196.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/digital-io/max22196/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/max22200.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/digital-io/max22200/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/max25603.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/led/max25603/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/max31827.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/temperature/max31827/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/max42500.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/power/max42500/README.rst
1 change: 1 addition & 0 deletions _sources/drivers/pulsar_adc.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../../../drivers/adc/pulsar_adc/README.rst
113 changes: 113 additions & 0 deletions _sources/drivers_doc.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
******************
no-OS drivers list
******************

The following sections contain code documentation for ADI no-OS drivers.

ACCELEROMETERS
==============
.. toctree::
:maxdepth: 1

drivers/adxl355

ANALOG TO DIGITAL CONVERTERS
============================
.. toctree::
:maxdepth: 1

drivers/adm1177
drivers/ad405x
drivers/ad796x
drivers/pulsar_adc

AXI CORES
=========
.. toctree::
:maxdepth: 1

drivers/axi_sysid

DIGITAL INPUT/OUTPUT
==========================
.. toctree::
:maxdepth: 1

drivers/max14914
drivers/max14919
drivers/max149x6
drivers/max22190
drivers/max22196
drivers/max22200

DIGITAL TO ANALOG CONVERTERS
============================
.. toctree::
:maxdepth: 1

drivers/max22017

FREQUENCY GENERATORS
====================
.. toctree::
:maxdepth: 1

drivers/adf4382

INERTIAL MEASUREMENT UNITS
==========================
.. toctree::
:maxdepth: 1

drivers/imu

LED
===
.. toctree::
:maxdepth: 1

drivers/max25603

METER
=====
.. toctree::
:maxdepth: 1

drivers/ade7816

RF TRANSCEIVER
==============
.. toctree::
:maxdepth: 1

drivers/madura

TEMPERATURE
==============
.. toctree::
:maxdepth: 1

drivers/max31827
drivers/ltc2983

POWER MANAGEMENT
================
.. toctree::
:maxdepth: 1

drivers/adp1050
drivers/ltc2992
drivers/ltc4296
drivers/lt7170
drivers/lt7182s
drivers/lt8491
drivers/lt8722
drivers/ltp8800
drivers/max42500

POTENTIOMETER
================
.. toctree::
:maxdepth: 1

drivers/ad5293
Loading

0 comments on commit d5251ef

Please sign in to comment.