circuitpython/docs/library/index.rst

.. _micropython_lib:

MicroPython libraries
=====================

.. warning::

    These modules are inherited from MicroPython and may not work in CircuitPython
    as documented or at all! If they do work, they may change at any time.


Python standard libraries and micro-libraries
---------------------------------------------


.. toctree::
   :maxdepth: 1

   builtins.rst
   array.rst
   gc.rst
   sys.rst
   binascii.rst
   collections.rst
   uerrno.rst
   hashlib.rst
   uheapq.rst
   uio.rst
   ujson.rst
   ure.rst
   uselect.rst
   usocket.rst
   ussl.rst
   ustruct.rst
   uzlib.rst


MicroPython-specific libraries
------------------------------

Functionality specific to the MicroPython implementation is available in
the following libraries.

.. toctree::
   :maxdepth: 1

   btree.rst
   framebuf.rst
   micropython.rst
   network.rst
   uctypes.rst

Libraries specific to the ESP8266
---------------------------------

The following libraries are specific to the ESP8266.

.. toctree::
  :maxdepth: 2

  esp.rst
reference/index: Rewrite introduction paragraph to avoid confusion. The old intro talked about "differences", but there were hardly any sections describing differences, mostly MicroPython specific features. On the other hand, we now have real "differences" chapter, though it's mostly concerned with stdlib differences. So, try to avoid confusion by changing wording and linking to the other chapters and contrasting them with what is described in "MicroPython language". 2017-07-01 15:09:40 -04:00			`.. _micropython_lib:`

docs: Change "Micro Python" to "MicroPython" in all places in docs. 2015-06-04 18:53:26 -04:00			`MicroPython libraries`
			`=====================`
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-30 21:37:19 -04:00
docs/library/index: Add important summary of the intro section as warning. To make them harder to miss. 2017-05-14 17:26:44 -04:00			`.. warning::`

Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215. 2018-02-20 20:34:59 -05:00			`These modules are inherited from MicroPython and may not work in CircuitPython`
			`as documented or at all! If they do work, they may change at any time.`

docs/library/index: Make single section for "micro-ified" modules. Even the modules whose names don't start with "u" prefix are micro-ified anyway, i.e. provide only subset of CPython's functionality (and sometimes extensions to it). So, it doesn't make much sense to devide them by criteria of having/not having "u" prefix. 2016-04-26 18:32:38 -04:00
			`Python standard libraries and micro-libraries`
			`---------------------------------------------`
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory. 2014-10-30 21:37:19 -04:00
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215. 2018-02-20 20:34:59 -05:00
			`.. toctree::`
			`:maxdepth: 1`

			`builtins.rst`
			`array.rst`
			`gc.rst`
			`sys.rst`
docs: fix references to ubinascii 2018-05-03 10:34:43 -04:00			`binascii.rst`
Update docs s/ucollections/collections/g 2018-05-14 14:31:56 -04:00			`collections.rst`
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215. 2018-02-20 20:34:59 -05:00			`uerrno.rst`
docs: fix references to uhashlib 2018-05-06 13:23:21 -04:00			`hashlib.rst`
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215. 2018-02-20 20:34:59 -05:00			`uheapq.rst`
			`uio.rst`
			`ujson.rst`
			`ure.rst`
			`uselect.rst`
			`usocket.rst`
			`ussl.rst`
			`ustruct.rst`
			`uzlib.rst`
docs/library/index: Move WiPy "micro-libraries" under corresponding heading. 2016-04-26 18:14:16 -04:00

docs/library/index: Order sections from the most to least standard modules. 2016-04-26 18:37:45 -04:00			`MicroPython-specific libraries`
			`------------------------------`

			`Functionality specific to the MicroPython implementation is available in`
			`the following libraries.`

			`.. toctree::`
			`:maxdepth: 1`

docs/library/btree: Add btree module docs. 2017-04-03 17:29:23 -04:00			`btree.rst`
docs/library: Add framebuf documentation. 2017-02-27 01:16:32 -05:00			`framebuf.rst`
docs/library/index: Order sections from the most to least standard modules. 2016-04-26 18:37:45 -04:00			`micropython.rst`
			`network.rst`
			`uctypes.rst`

Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215. 2018-02-20 20:34:59 -05:00			`Libraries specific to the ESP8266`
			`---------------------------------`
docs/library/index: Order sections from the most to least standard modules. 2016-04-26 18:37:45 -04:00
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215. 2018-02-20 20:34:59 -05:00			`The following libraries are specific to the ESP8266.`
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
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215. 2018-02-20 20:34:59 -05:00			`.. toctree::`
			`:maxdepth: 2`
docs: Document esp module for ESP8266. I document as much as I could guess from experiments and reading the code for the ``esp`` module for the ESP8266 port of Micropython. For now the tag has to be set manually with -t option when building, when we have properly split documentation, there will be a separate config file for esp8266 with that the tag "port_esp8266" set. To build use: make SPHINXOPTS="-t port_esp8266" html 2015-05-26 17:34:31 -04:00
Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215. 2018-02-20 20:34:59 -05:00			`esp.rst`