doc: added Sphinx documentation for iio_attr.py.

Updated the .rst files in order to display a documentation page for iio_attr.py. Signed-off-by: Cristi Iacob <[email protected]>
analogdevicesinc · May 29, 2020 · 68a7716 · 68a7716
1 parent 6a6432b
commit 68a7716
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/bindings/python/doc/examples.rst b/bindings/python/doc/examples.rst
@@ -7,6 +7,7 @@ Complete Application Examples
 .. toctree::
    iio_readdev
    iio_writedev
+   iio_attr
    iio_info
 
 

diff --git a/bindings/python/doc/iio_attr.rst b/bindings/python/doc/iio_attr.rst
@@ -0,0 +1,11 @@
+iio_attr
+======================
+| iio_attr is part of the Libiio package, a library that has been developed to ease the development of software interfacing Linux Industrial I/O (IIO) devices.
+| This tool is written using the libiio Python bindings. It works in a very similar way of how the base iio_attr works. You can find more informations about it on this `page <https://wiki.analog.com/resources/tools-software/linux-software/libiio/iio_attr>`_.
+
+.. automodule:: iio_attr
+   :members:
+
+.. literalinclude:: ../examples/iio_attr.py
+   :language: python
+