Raspberries/mraa
Private
Public Access
2
0
Fork 0
Code Activity

Travis CI and Documentation Generation improvements

Browse Source 
* Use docker images from docker hub instead of building them on Travis
* Fix doxygen warnings for C/C++ Documentation
* Fix examples inclusion in documentation
* Modify Travis build matrix to include stages and additional jobs
* Update doxygen2jsdoc submodule
* Add doxyport submodule
* Generate documentation for each language in Travis
* Add sonar.java.binaries to sonar-scan.sh

Signed-off-by: Nicolas Oliver <dario.n.oliver@intel.com>
This commit is contained in:
Nicolas Oliver
2017-07-28 10:48:48 -03:00
parent 14bf91af44
commit e0a1862ce3
51 changed files with 486 additions and 434 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/python/python2/docs/example.rst
View File

@@ -12,12 +12,12 @@ Hello GPIO
Here is the simplest Gpio program in mraa.
.. literalinclude:: ../../../examples/python/hello_gpio.py
.. literalinclude:: ../../../../examples/python/hello_gpio.py
:prepend: import mraa
:start-after: import mraa
GPIO Interrupt (isr)
===================
====================
The GPIO module allows you to set an interrupt on a GPIO. This interrupt is
controlled by the mode that the 'edge' is in. Before setting another isr please
@@ -27,7 +27,7 @@ values.
**Note:** Galileo Gen1 only supports EDGE_BOTH
.. literalinclude:: ../../../examples/python/hello_isr.py
.. literalinclude:: ../../../../examples/python/hello_isr.py
:prepend: import mraa
:start-after: import mraa
@@ -44,11 +44,11 @@ The I2c module module has a number of different ways of interacting with the
i2c bus, including a number of overloaded read() calls and the writeReg()
helper function.
.. literalinclude:: ../../../examples/python/bmp85.py
.. literalinclude:: ../../../../examples/python/bmp85.py
:prepend: x = m.I2c(0)
:start-after: x = m.I2c(0)
.. literalinclude:: ../../../docs/i2c.txt
.. literalinclude:: ../../../../docs/i2c.txt
Pwm
===
@@ -56,7 +56,7 @@ Pwm
The PWM module is rather simple, note that different hardware support PWM
generation is various different ways so results may vary.
.. literalinclude:: ../../../examples/python/cycle-pwm3.py
.. literalinclude:: ../../../../examples/python/cycle-pwm3.py
:prepend: import mraa
:start-after: import mraa
@@ -67,7 +67,7 @@ The ADC is typically provided on a dedicated or shared SPI bus, this is
abstracted by the Linux kernel as spidev and abstracted again by mraa. It is
fairly simple in use.
.. literalinclude:: ../../../examples/python/aio.py
.. literalinclude:: ../../../../examples/python/aio.py
:prepend: import mraa
:start-after: import mraa
@@ -82,12 +82,12 @@ Here's a simple pair of programs comprising a sender and receiver pair.
Sender:
.. literalinclude:: ../../../examples/python/uart_sender.py
.. literalinclude:: ../../../../examples/python/uart_sender.py
:prepend: import mraa
:start-after: import mraa
Receiver:
.. literalinclude:: ../../../examples/python/uart_receiver.py
.. literalinclude:: ../../../../examples/python/uart_receiver.py
:prepend: import mraa
:start-after: import mraa