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

docs: Improve python docs

Browse Source 
This commit adds a bunch of includes from the C/C++ doxygen doc into the
sphinx/python doc to make it more useful. It also splits out the doc of the
classes using autoclass instead of autodoc to make it nicer to navigate.

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2015-04-03 19:41:52 +01:00
parent 6aa601cd1d
commit 2138802b59
4 changed files with 82 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/python/docs/example.rst
View File

@@ -44,9 +44,9 @@ 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/i2c_HMC5883.py
:prepend: x = mraa.I2c(0)
:start-after: x = mraa.I2c(0)
.. literalinclude:: ../../../examples/python/bmp85.py
:prepend: x = m.I2c(0)
:start-after: x = m.I2c(0)
.. literalinclude:: ../../../docs/i2c.txt