From 293d99c775fc88605c7fb3c15b346c8128d89b79 Mon Sep 17 00:00:00 2001 From: Cristi Iacob Date: Wed, 8 Apr 2020 14:28:10 +0300 Subject: [PATCH] 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 --- bindings/python/doc/iio_readdev.rst | 7 +++++++ bindings/python/doc/iio_writedev.rst | 7 +++++++ bindings/python/doc/index.rst | 1 + bindings/python/doc/tools.rst | 8 ++++++++ 4 files changed, 23 insertions(+) create mode 100644 bindings/python/doc/iio_readdev.rst create mode 100644 bindings/python/doc/iio_writedev.rst create mode 100644 bindings/python/doc/tools.rst diff --git a/bindings/python/doc/iio_readdev.rst b/bindings/python/doc/iio_readdev.rst new file mode 100644 index 000000000..d6eda73ad --- /dev/null +++ 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 `_. + +.. automodule:: examples.iio_readdev + :members: diff --git a/bindings/python/doc/iio_writedev.rst b/bindings/python/doc/iio_writedev.rst new file mode 100644 index 000000000..73935287f --- /dev/null +++ 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 `_. + +.. automodule:: examples.iio_writedev + :members: diff --git a/bindings/python/doc/index.rst b/bindings/python/doc/index.rst index 2167e18e2..0e45e8bb9 100644 --- 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 new file mode 100644 index 000000000..e2504d220 --- /dev/null +++ b/bindings/python/doc/tools.rst @@ -0,0 +1,8 @@ +Tools +====================== + +Components +---------------------- +.. toctree:: + iio_readdev + iio_writedev