You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Scott Shawcroft 7b393bc406
Merge tag 'v1.9.3'
5 years ago
differences reference/index: Rewrite introduction paragraph to avoid confusion. 6 years ago
esp8266 Merge tag 'v1.9.3' 5 years ago
library Merge tag 'v1.9.3' 5 years ago
pyboard Merge tag 'v1.9.3' 5 years ago
readthedocs/settings docs: Add RTD local_settings file, to add custom templates. 8 years ago
reference docs/reference/isr_rules: Minor typo correction. 5 years ago
sphinx_selective_exclude various: Spelling fixes 6 years ago
static Update favicon to blinka. 6 years ago
templates docs/pyboard: Move info about using Windows from topindex to general. 6 years ago
wipy Merge tag 'v1.9.1' 6 years ago
Makefile docs/Makefile: define and use PYTHON as the interpreter for CPYDIFF 6 years ago Update docs README to mention requirement for recommonmark dependency. 6 years ago Documentation rework to unify the docs together rather than having them 6 years ago docs: Minor updates before 1.0.0 6 years ago
design_guide.rst updated I2C example (#371) 5 years ago
drivers.rst updated the http reference for max7219 to use the readthedocs from the adafruit cirtcuitpython area instead of the micropython area 5 years ago
esp8266_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 6 years ago
porting.rst Move to ASF4 and introduce SAMD51 support. (#258) 5 years ago
pyboard_index.rst docs/pyboard: Move hardware info into General Info chapter. 6 years ago
supported_ports.rst docs: Typos and rename to CircuitPython. 6 years ago
troubleshooting.rst Style tweaks based on @willingc's feedback. 5 years ago
unix_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 6 years ago
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. 6 years ago
wipy_index.rst docs/*_index: Drop "Indices and tables" pseudo-section. 6 years ago

Adafruit's CircuitPython Documentation

The latest documentation can be found at:

The documentation you see there is generated from the files in the whole tree:

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.