d201ac20af
RST is very picky about spacing. |
||
|---|---|---|
| .. | ||
| differences | ||
| esp8266 | ||
| library | ||
| pyboard | ||
| readthedocs/settings | ||
| reference | ||
| sphinx_selective_exclude | ||
| static | ||
| templates | ||
| wipy | ||
| Makefile | ||
| README.md | ||
| c2rst.py | ||
| common_hal.md | ||
| design_guide.rst | ||
| drivers.rst | ||
| esp8266_index.rst | ||
| porting.rst | ||
| pyboard_index.rst | ||
| supported_ports.rst | ||
| troubleshooting.rst | ||
| unix_index.rst | ||
| unsupported_ports.rst | ||
| wipy_index.rst | ||
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.