circuitpython/docs
Scott Shawcroft d201ac20af Fix sensor table. (#517)
RST is very picky about spacing.
2018-01-08 20:38:43 -05:00
..
differences reference/index: Rewrite introduction paragraph to avoid confusion. 2017-07-01 22:09:40 +03:00
esp8266 Merge tag 'v1.9.3' 2017-11-02 12:41:50 -07:00
library Merge tag 'v1.9.3' 2017-11-02 12:41:50 -07:00
pyboard Merge tag 'v1.9.3' 2017-11-02 12:41:50 -07:00
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 2014-12-21 11:21:06 +00:00
reference docs/reference/isr_rules: Minor typo correction. 2017-10-30 13:29:00 +11:00
sphinx_selective_exclude various: Spelling fixes 2017-05-29 11:36:05 +03:00
static Update favicon to blinka. 2017-07-28 16:33:07 -07:00
templates docs/pyboard: Move info about using Windows from topindex to general. 2017-07-03 15:31:41 +10:00
wipy Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07: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 Documentation rework to unify the docs together rather than having them 2016-10-18 17:42:47 -07:00
common_hal.md docs: Minor updates before 1.0.0 2017-07-19 15:13:23 -04:00
design_guide.rst Fix sensor table. (#517) 2018-01-08 20:38:43 -05:00
drivers.rst updated the http reference for max7219 to use the readthedocs from the adafruit cirtcuitpython area instead of the micropython area 2017-09-07 22:07:45 -07:00
esp8266_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 2017-07-02 19:18:51 +03:00
porting.rst Move to ASF4 and introduce SAMD51 support. (#258) 2017-09-22 21:05:51 -04:00
pyboard_index.rst docs/pyboard: Move hardware info into General Info chapter. 2017-07-02 19:23:23 +03:00
supported_ports.rst docs: Typos and rename to CircuitPython. 2017-06-27 17:37:03 -07:00
troubleshooting.rst merge from 2.2.0 + fix up board defs 2018-01-02 21:25:41 -05:00
unix_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 2017-07-02 19:18:51 +03:00
unsupported_ports.rst This introduces an alternative hardware API called nativeio structured around different functions that are typically accelerated by native hardware. Its not meant to reflect the structure of the hardware. 2016-11-21 14:11:52 -08:00
wipy_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 2017-07-02 19:18:51 +03: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.