circuitpython/docs/index.rst

MicroPython documentation and references
========================================

.. toctree::

    library/index.rst
    reference/index.rst
    genrst/index.rst
    develop/index.rst
    license.rst
    pyboard/quickref.rst
    esp8266/quickref.rst
    esp32/quickref.rst
    rp2/quickref.rst
    wipy/quickref.rst
    unix/quickref.rst
    zephyr/quickref.rst
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive. 2015-06-10 17:29:56 -04:00			`MicroPython documentation and references`
			`========================================`

			`.. toctree::`

			`library/index.rst`
docs: Move all ports docs to the single ToC. Previously, only "selected chapters" were shown in left-pane ToC (of Read The Docs theme). These chapters were selected out of order. The rest of chapters were hidden beyond "Documentation Contents" pseudo- chapter. This arguably led only to confusion, as many people probably never tried to open that pseudo-chapter, and those who did, were confused. Such organization is even worse for PDF output, causing chapters go in mix-mashed order. So, instead move to single clean ToC. This will allow readers of HTML to have access to any doc content at their fingertips (and straight before their eyes), and will allow to finally have clean PDF docs. 2017-06-26 17:34:10 -04:00			`reference/index.rst`
docs: Modify Makefile and indexes to generate cPy-differences pages. 2017-02-07 00:00:34 -05:00			`genrst/index.rst`
py: Update and rework build system for including external C modules. How to use this feature is documented in docs/develop/cmodules.rst. 2018-12-12 00:50:55 -05:00			`develop/index.rst`
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive. 2015-06-10 17:29:56 -04:00			`license.rst`
docs: Unify all the ports into one set of documentation. With this commit there is now only one entry point into the whole documentation, which describes the general MicroPython language, and then from there there are links to information about specific platforms/ports. This commit doesn't change content (almost, it does fix a few internal links), it just reorganises things. 2018-09-27 03:27:57 -04:00			`pyboard/quickref.rst`
			`esp8266/quickref.rst`
docs: Add initial docs for esp32 port, including quick-ref and general. With contributions from Oliver Robson (@HowManyOliversAreThere), Sean Lanigan (@seanlano) and @rprr. 2019-01-21 16:06:17 -05:00			`esp32/quickref.rst`
docs/rp2: Add skeleton docs for the rp2 port. 2021-05-23 03:20:43 -04:00			`rp2/quickref.rst`
docs: Unify all the ports into one set of documentation. With this commit there is now only one entry point into the whole documentation, which describes the general MicroPython language, and then from there there are links to information about specific platforms/ports. This commit doesn't change content (almost, it does fix a few internal links), it just reorganises things. 2018-09-27 03:27:57 -04:00			`wipy/quickref.rst`
docs/unix: Add a new new quickref page for the UNIX port. This adds a new quickstart page for the UNIX port that documents the command line options and environment variables. 2020-01-24 15:37:26 -05:00			`unix/quickref.rst`
docs/zephyr: Add quick reference for the Zephyr port. Includes an introduction to using the Zephyr port on MicroPython. The quickref details examples of how to use each module the port currently supports. The tutorial provides additional details for Zephyr specific modules. Signed-off-by: Julia Hathaway <julia.hathaway@nxp.com> 2021-08-02 18:01:57 -04:00			`zephyr/quickref.rst`