python: include examples page for sphinx documentation that links to src examples
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
25
src/python/docs/example.rst
Normal file
25
src/python/docs/example.rst
Normal file
@@ -0,0 +1,25 @@
|
||||
#######
|
||||
Example
|
||||
#######
|
||||
Here are some examples of how to use pymaa, common convention is to import pymaa as maa to keep it short but feel free to import it globally!
|
||||
|
||||
Hello GPIO
|
||||
==========
|
||||
|
||||
Here is the simplest Gpio program in pymaa.
|
||||
|
||||
.. literalinclude:: ../../../examples/python/hello_gpio.py
|
||||
:prepend: import pymaa
|
||||
:start-after: import pymaa
|
||||
|
||||
GPIO Interupt (isr)
|
||||
===================
|
||||
|
||||
The GPIO module allows you to set an interupt on a GPIO. This interupt is controlled by the mode that the 'edge' is in.
|
||||
|
||||
**Note:** Galileo Gen1 only supports EDGE_BOTH
|
||||
|
||||
.. literalinclude:: ../../../examples/python/hello_isr.py
|
||||
:prepend: import pymaa as maa
|
||||
:start-after: import pymaa as maa
|
||||
|
||||
Reference in New Issue
Block a user