circuitpython/docs
Scott Shawcroft f4563d11d1
Add four missing drivers
2018-03-27 14:25:14 -07:00
..
library Merge remote-tracking branch 'adafruit/2.x' into merge_2x 2018-02-27 15:24:16 -08:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
static Update favicon to blinka. 2017-07-28 16:33:07 -07:00
templates Delete a bunch of docs, drivers and examples not relevant to CircuitPython. 2018-02-20 17:34:59 -08:00
Makefile docs/Makefile: define and use PYTHON as the interpreter for CPYDIFF 2017-02-27 15:39:55 +11:00
README.md Update docs README to mention requirement for recommonmark dependency. 2017-08-16 15:23:42 -07:00
c2rst.py Remove bad c2rst and fix the other for sphinx 1.7.1 2018-02-27 18:08:49 -08:00
common_hal.md docs: Minor updates before 1.0.0 2017-07-19 15:13:23 -04:00
design_guide.rst Merge remote-tracking branch 'adafruit/2.x' into merge_2x 2018-02-27 15:24:16 -08:00
drivers.rst Add four missing drivers 2018-03-27 14:25:14 -07:00
index.rst Merge remote-tracking branch 'adafruit/2.x' into merge_2x 2018-02-27 15:24:16 -08:00
porting.rst Merge remote-tracking branch 'adafruit/2.x' into merge_2x 2018-02-27 15:24:16 -08:00
supported_ports.rst Merge remote-tracking branch 'adafruit/2.x' into merge_2x 2018-02-27 15:24:16 -08:00
troubleshooting.rst Delete a bunch of docs, drivers and examples not relevant to CircuitPython. 2018-02-20 17:34:59 -08:00

README.md

Adafruit's CircuitPython Documentation

The latest documentation can be found at: http://circuitpython.readthedocs.io/en/latest/

The documentation you see there is generated from the files in the whole tree: https://github.com/adafruit/circuitpython/tree/master

Building the documentation locally

If you're making changes to the documentation, you should build the documentation locally so that you can preview your changes.

Install Sphinx, recommonmark, and optionally (for the RTD-styling), sphinx_rtd_theme, preferably in a virtualenv:

 pip install sphinx
 pip install recommonmark
 pip install sphinx_rtd_theme

In circuitpython/, build the docs:

sphinx-build -v -b html . _build/html

You'll find the index page at _build/html/index.html.