python: Added .rst files for sphinx.

Added .rst files for iio_readdev.py and iio_writedev.py. Also I have added a new component, Tools, on the main page, containing references to iio_readdev and iio_writedev. Signed-off-by: Cristi Iacob <[email protected]>
analogdevicesinc · Apr 9, 2020 · 293d99c · 293d99c
1 parent 2cd5a0f
commit 293d99c
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/bindings/python/doc/iio_readdev.rst b/bindings/python/doc/iio_readdev.rst
@@ -0,0 +1,7 @@
+iio_readdev
+=====================
+| iio_readdev 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 the same way as the base iio_readdev works. You can find more informations about it on this `page <https://wiki.analog.com/resources/tools-software/linux-software/libiio/iio_readdev?s[]=readdev>`_.
+
+.. automodule:: examples.iio_readdev
+   :members:
diff --git a/bindings/python/doc/iio_writedev.rst b/bindings/python/doc/iio_writedev.rst
@@ -0,0 +1,7 @@
+iio_writedev
+=====================
+| iio_writedev 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 the same way as the base iio_writedev works. You can find more informations about it on this `page <https://wiki.analog.com/resources/tools-software/linux-software/libiio/iio_writedev>`_.
+
+.. automodule:: examples.iio_writedev
+   :members:
diff --git a/bindings/python/doc/index.rst b/bindings/python/doc/index.rst
@@ -43,6 +43,7 @@ Components
    channel
    trigger
    examples
+   tools
 
 Indices and tables
 ==================

diff --git a/bindings/python/doc/tools.rst b/bindings/python/doc/tools.rst
@@ -0,0 +1,8 @@
+Tools
+======================
+
+Components
+----------------------
+.. toctree::
+   iio_readdev
+   iio_writedev
-Original file line number
+Diff line change
@@ Expand Up / @@ -43,6 +43,7 @@ Components @@
        channel
        trigger
        examples
+       tools
     Indices and tables
     ==================
@@ Expand Down @@