blob: 15db6aef13d95fe3765a143d864a057ddea81718 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
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`.
|
