diff options
| author | Damien George <damien.p.george@gmail.com> | 2018-07-20 15:34:22 +1000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2018-07-20 15:34:22 +1000 |
| commit | 84d5dd46fec2aa5a7c585e42927178acf2055405 (patch) | |
| tree | fb94aeb16cecfaaae14f7ce298e021151808dcc5 /docs/library/index.rst | |
| parent | feec0a6909c00ebf0df3250fabaaf10bff73614b (diff) | |
docs/library/index: Remove all conditionals from library index.
It's fair to just provide a link to all available modules, regardless of
the port. Most of the existing ports (unix, stm32, esp8266, esp32) share
most of the same set of modules anyway, so no need to maintain separate
lists for them. And there's a big discussion at the start of this index
about modules not being available on a given port.
For port-specific modules, they can also be listed unconditionally because
they have headings that explicitly state they are only available on certain
ports.
Diffstat (limited to 'docs/library/index.rst')
| -rw-r--r-- | docs/library/index.rst | 166 |
1 files changed, 44 insertions, 122 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst index 40fe641c8..337a05d41 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -65,104 +65,31 @@ For example, ``import json`` will first search for a file ``json.py`` (or packag directory ``json``) and load that module if it is found. If nothing is found, it will fallback to loading the built-in ``ujson`` module. -.. only:: port_unix - - .. toctree:: - :maxdepth: 1 - - builtins.rst - array.rst - cmath.rst - gc.rst - math.rst - sys.rst - ubinascii.rst - ucollections.rst - uerrno.rst - uhashlib.rst - uheapq.rst - uio.rst - ujson.rst - uos.rst - ure.rst - uselect.rst - usocket.rst - ussl.rst - ustruct.rst - utime.rst - uzlib.rst - _thread.rst - -.. only:: port_pyboard - - .. toctree:: - :maxdepth: 1 - - builtins.rst - array.rst - cmath.rst - gc.rst - math.rst - sys.rst - ubinascii.rst - ucollections.rst - uerrno.rst - uhashlib.rst - uheapq.rst - uio.rst - ujson.rst - uos.rst - ure.rst - uselect.rst - usocket.rst - ustruct.rst - utime.rst - uzlib.rst - _thread.rst - -.. only:: port_wipy - - .. toctree:: - :maxdepth: 1 - - builtins.rst - array.rst - gc.rst - sys.rst - ubinascii.rst - ujson.rst - uos.rst - ure.rst - uselect.rst - usocket.rst - ussl.rst - utime.rst - -.. only:: port_esp8266 - - .. toctree:: - :maxdepth: 1 - - builtins.rst - array.rst - gc.rst - math.rst - sys.rst - ubinascii.rst - ucollections.rst - uerrno.rst - uhashlib.rst - uheapq.rst - uio.rst - ujson.rst - uos.rst - ure.rst - uselect.rst - usocket.rst - ussl.rst - ustruct.rst - utime.rst - uzlib.rst +.. toctree:: + :maxdepth: 1 + + builtins.rst + array.rst + cmath.rst + gc.rst + math.rst + sys.rst + ubinascii.rst + ucollections.rst + uerrno.rst + uhashlib.rst + uheapq.rst + uio.rst + ujson.rst + uos.rst + ure.rst + uselect.rst + usocket.rst + ussl.rst + ustruct.rst + utime.rst + uzlib.rst + _thread.rst MicroPython-specific libraries @@ -183,40 +110,35 @@ the following libraries. uctypes.rst -.. only:: port_pyboard - - Libraries specific to the pyboard - --------------------------------- - - The following libraries are specific to the pyboard. +Libraries specific to the pyboard +--------------------------------- - .. toctree:: - :maxdepth: 2 +The following libraries are specific to the pyboard. - pyb.rst - lcd160cr.rst +.. toctree:: + :maxdepth: 2 -.. only:: port_wipy + pyb.rst + lcd160cr.rst - Libraries specific to the WiPy - --------------------------------- - The following libraries are specific to the WiPy. +Libraries specific to the WiPy +------------------------------ - .. toctree:: - :maxdepth: 2 +The following libraries are specific to the WiPy. - wipy.rst +.. toctree:: + :maxdepth: 2 + wipy.rst -.. only:: port_esp8266 - Libraries specific to the ESP8266 - --------------------------------- +Libraries specific to the ESP8266 +--------------------------------- - The following libraries are specific to the ESP8266. +The following libraries are specific to the ESP8266. - .. toctree:: - :maxdepth: 2 +.. toctree:: + :maxdepth: 2 - esp.rst + esp.rst |