Sam Bristow
783bfacee8
Use new python-serial API
...
Version 3.0 of python-serial introduced an updated API, we may as well
use it.
This change also uses context-managers for dealing with UARTs as they
are less error-prone and the code is much cleaner/shorter.
2018-10-09 23:39:43 +13:00
Drew Fustini
829f97a917
Update ADC.rst
2018-08-16 01:20:47 -05:00
Drew Fustini
4a82f4c430
Update Encoder.rst
2018-08-16 01:17:32 -05:00
Drew Fustini
e9d56e06c7
Update ADC.rst
...
testing readthedocs webhook
2018-08-16 01:06:50 -05:00
Franklin S Cooper Jr
44c371a77a
docs/GPIO.rst Make documentation a bit newbie friendly
...
Make it clear in the parameter snippet that the various attributes
belong to the GPIO class.
Signed-off-by: Franklin S Cooper Jr <fcooper27@gmail.com>
2018-07-31 21:17:50 -05:00
Franklin S Cooper Jr
61ca14b926
docs/GPIO.rst: Add information on blinking led
...
Copy information regarding blinking leds to the GPIO documentation
Signed-off-by: Franklin S Cooper Jr <fcooper27@gmail.com>
2018-07-31 21:03:29 -05:00
Franklin S Cooper Jr
339314535b
docs/SPI.rst: Fix bus numbering in examples
...
Commit 8dfbf64c36#216 )")
changes how the SPI constructor maps to the spidev entry.
Update the documentation to reflect this change.
Signed-off-by: Franklin S Cooper Jr <fcooper27@gmail.com>
2018-07-31 20:44:11 -05:00
David Planella
14f1f79385
Updated ADC API docs
2017-12-05 08:44:52 +01:00
David Planella
2978a08fcb
Update docs generation description to reflect new separate modules
2017-12-04 14:25:02 +01:00
David Planella
ee6bd69a9f
Improvements to the API docs output config
2017-12-04 13:57:24 +01:00
David Planella
edc1799df2
Generate the API documentation from a master index and a separate file for each module
2017-12-04 13:50:41 +01:00
David Planella
9d6aa46a61
Update README.md
2017-12-02 18:57:58 +01:00
David Planella
55aa0a9da4
rST fixes
2017-12-02 18:25:48 +01:00
David Planella
f12715b277
Finished documenting GPIO
2017-12-02 18:19:00 +01:00
David Planella
6e9ea9245d
Minor documentation and configuration improvements
2017-12-02 16:27:48 +01:00
David Planella
a86300f184
Added some more API doc content
2017-12-02 15:56:13 +01:00
David Planella
6e0cf949db
Documented the API docs build process
2017-12-02 14:07:22 +01:00
David Planella
4ab134b572
Added SPI pins table and first shot at GPIO module. Functions still need to be documented
2017-12-02 14:07:22 +01:00
David Planella
2769792028
Added SPI module attribute docs
2017-12-02 14:07:22 +01:00
David Planella
191b21408e
API docs: added SPI module
2017-12-02 14:07:22 +01:00
David Planella
330b0f270a
Added ADC API docs, fixed UART module definition
2017-12-02 14:07:22 +01:00
David Planella
0dc0ca73ab
Added UART documentation
2017-12-02 14:07:22 +01:00
David Planella
f9212b2676
Removed redundant TOC, added global description
2017-12-02 14:07:22 +01:00
David Planella
be0a908142
Readthedocs theme tweaks
2017-12-02 14:07:22 +01:00
David Planella
24337296dd
Use readthedocs theme if building docs there, remove redundand search link
2017-12-02 14:07:22 +01:00
David Planella
fa5a786ab3
Use the default readthedocs theme
2017-12-02 14:07:22 +01:00
David Planella
32e63c992d
Added docstrings using Google syntax and Sphinx support to generate the API documentation for the Encoder and PWM modules for now.
2017-12-02 14:07:22 +01:00
