Skip to content

Commit f99017d

Browse files
committed
sphinx: set up the examples so they show up in the generated doc
This tweaks the conf.py.in config so that examples shows up in the examples section of the doc. Note: These are examples, not tools, as tools are deployed, and examples are not. Since they are not deployed, just call them examples. Also include iio_info to the list. Signed-off-by: Robin Getz <[email protected]>
1 parent 9960759 commit f99017d

File tree

7 files changed

+24
-12
lines changed

7 files changed

+24
-12
lines changed

bindings/python/doc/conf.py.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
import os
1414
import sys
1515
sys.path.insert(0, os.path.abspath('../.'))
16+
sys.path.insert(0, os.path.abspath('../examples'))
1617

1718
import sphinx_rtd_theme
1819

bindings/python/doc/examples.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
Examples
22
==================
33

4+
5+
Complete Application Examples
6+
------------------------------
7+
.. toctree::
8+
iio_readdev
9+
iio_writedev
10+
iio_info
11+
12+
13+
Code Snippets
14+
-----------------------------
15+
416
Scan contexts and list channels of each device
517

618
.. code-block:: python

bindings/python/doc/iio_info.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
iio_info
2+
=====================
3+
| iio_info 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.
4+
| This tool is written using the libiio Python bindings. It works in the same way as the base iio_info works. You can find more informations about it on this `page <https://wiki.analog.com/resources/tools-software/linux-software/libiio/iio_info>`_.
5+
6+
.. automodule:: iio_info
7+
:members:
8+
:undoc-members:

bindings/python/doc/iio_readdev.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ iio_readdev
33
| 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.
44
| 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>`_.
55
6-
.. automodule:: examples.iio_readdev
6+
.. automodule:: iio_readdev
77
:members:

bindings/python/doc/iio_writedev.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ iio_writedev
33
| 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.
44
| 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>`_.
55
6-
.. automodule:: examples.iio_writedev
6+
.. automodule:: iio_writedev
77
:members:

bindings/python/doc/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
libiio Python Bindings
22
==================================
33

4-
Python bindings for the Industrial I/O interface library.
4+
Python bindings for the `Industrial I/O <../index.html>`_ interface library.
55

66
Installation
77
==================
@@ -43,7 +43,6 @@ Components
4343
channel
4444
trigger
4545
examples
46-
tools
4746

4847
Indices and tables
4948
==================

bindings/python/doc/tools.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)