summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/index.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-04-27 01:32:38 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-04-27 01:38:59 +0300
commit492bf1249942b033f3aac8af357bd617f6ce17fe (patch)
tree4c19d938bbe556096140112b1ad32cefa91d1608 /docs/library/index.rst
parent678f3a1e05874d954ef21b9c34fdc2eb5a35c9ef (diff)
downloadmicropython-492bf1249942b033f3aac8af357bd617f6ce17fe.tar.gz
micropython-492bf1249942b033f3aac8af357bd617f6ce17fe.zip
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.
Diffstat (limited to 'docs/library/index.rst')
-rw-r--r--docs/library/index.rst108
1 files changed, 56 insertions, 52 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst
index a4e48d7e04..83a699fd05 100644
--- a/docs/library/index.rst
+++ b/docs/library/index.rst
@@ -1,6 +1,11 @@
MicroPython libraries
=====================
+The following standard Python libraries are built in to MicroPython.
+
+For additional libraries, please download them from the `micropython-lib repository
+<https://github.com/micropython/micropython-lib>`_.
+
MicroPython-specific libraries
------------------------------
@@ -15,49 +20,79 @@ the following libraries.
network.rst
uctypes.rst
-Python standard libraries
--------------------------
+Python standard libraries and micro-libraries
+---------------------------------------------
-The following standard Python libraries are built in to MicroPython.
+The following standard Python libraries have been "micro-ified" to fit in with
+the philosophy of MicroPython. They provide the core functionality of that
+module and are intended to be a drop-in replacement for the standard Python
+library.
-For additional libraries, please download them from the `micropython-lib repository
-<https://github.com/micropython/micropython-lib>`_.
+.. only:: not port_unix
+
+ The modules are available by their u-name, and also by their non-u-name. The
+ non-u-name can be overridden by a file of that name in your package path.
+ For example, ``import json`` will first search for a file ``json.py`` or
+ directory ``json`` and load that package if it is found. If nothing is found,
+ it will fallback to loading the built-in ``ujson`` module.
.. only:: port_unix
.. toctree::
:maxdepth: 1
-
+
cmath.rst
gc.rst
math.rst
os.rst
+ select.rst
sys.rst
- time.rst
+ ubinascii.rst
+ uhashlib.rst
+ uheapq.rst
+ ujson.rst
+ ure.rst
+ usocket.rst
+ ustruct.rst
+ utime.rst
+ uzlib.rst
.. only:: port_pyboard
.. toctree::
:maxdepth: 1
-
+
cmath.rst
gc.rst
math.rst
os.rst
select.rst
sys.rst
- time.rst
+ ubinascii.rst
+ uhashlib.rst
+ uheapq.rst
+ ujson.rst
+ ure.rst
+ usocket.rst
+ ustruct.rst
+ utime.rst
+ uzlib.rst
.. only:: port_wipy
.. toctree::
:maxdepth: 1
-
+
gc.rst
os.rst
select.rst
sys.rst
- time.rst
+ ubinascii.rst
+ ujson.rst
+ ure.rst
+ usocket.rst
+ ussl.rst
+ utime.rst
.. only:: port_esp8266
@@ -66,49 +101,18 @@ For additional libraries, please download them from the `micropython-lib reposit
gc.rst
math.rst
+ os.rst
sys.rst
- time.rst
-
-Python micro-libraries
-----------------------
-
-The following standard Python libraries have been "micro-ified" to fit in with
-the philosophy of MicroPython. They provide the core functionality of that
-module and are intended to be a drop-in replacement for the standard Python
-library.
-
-.. only:: not port_unix
-
- The modules are available by their u-name, and also by their non-u-name. The
- non-u-name can be overridden by a file of that name in your package path.
- For example, ``import json`` will first search for a file ``json.py`` or
- directory ``json`` and load that package if it is found. If nothing is found,
- it will fallback to loading the built-in ``ujson`` module.
-
-.. only:: port_unix or port_pyboard or port_esp8266
-
- .. toctree::
- :maxdepth: 1
-
- ubinascii.rst
- uhashlib.rst
- uheapq.rst
- ujson.rst
- ure.rst
- usocket.rst
- ustruct.rst
- uzlib.rst
-
-.. only:: port_wipy
-
- .. toctree::
- :maxdepth: 1
+ ubinascii.rst
+ uhashlib.rst
+ uheapq.rst
+ ujson.rst
+ ure.rst
+ usocket.rst
+ ustruct.rst
+ utime.rst
+ uzlib.rst
- ubinascii.rst
- ujson.rst
- ure.rst
- usocket.rst
- ussl.rst
.. only:: port_pyboard