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:
@@ -27,7 +27,8 @@ cmake and default system libraries are technically required to compile.
|
|||||||
module so comment out add_directories(javacsript) in src/CmakeLists.txt)
|
module so comment out add_directories(javacsript) in src/CmakeLists.txt)
|
||||||
4. doxygen (needed to generate even python doc)
|
4. doxygen (needed to generate even python doc)
|
||||||
5. sphinx
|
5. sphinx
|
||||||
6. pydoc
|
6. pygments
|
||||||
|
7. pydoc
|
||||||
|
|
||||||
To install swig-v8 the swig-v8-git package from AUR is helpful.
|
To install swig-v8 the swig-v8-git package from AUR is helpful.
|
||||||
|
|
||||||
|
|||||||
@@ -24,4 +24,7 @@
|
|||||||
|
|
||||||
import pymaa
|
import pymaa
|
||||||
|
|
||||||
|
print (pymaa.getVersion())
|
||||||
x = pymaa.Gpio(13)
|
x = pymaa.Gpio(13)
|
||||||
|
x.dir(pymaa.DIR_OUT)
|
||||||
|
x.write(1)
|
||||||
|
|||||||
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
|
||||||
|
|
||||||
@@ -9,9 +9,10 @@ Welcome to Pymaa's documentation!
|
|||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 4
|
:maxdepth: 2
|
||||||
|
|
||||||
pymaa
|
pymaa
|
||||||
|
example
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
|||||||
Reference in New Issue
Block a user