aboutsummaryrefslogtreecommitdiff
path: root/docs/library/index.rst
AgeCommit message (Collapse)Author
2020-09-04all: Rename "sys" module to "usys".stijn
This is consistent with the other 'micro' modules and allows implementing additional features in Python via e.g. micropython-lib's sys. Note this is a breaking change (not backwards compatible) for ports which do not enable weak links, as "import sys" must now be replaced with "import usys".
2020-06-05docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build.David Lechner
This enables warnings as errors and fixes all current errors, namely: - reference to terms in the glossary must now be explicit (:term:) - method overloads must not be declared as a separate method or must use :noindex: - 2 cases where `` should have been used instead of `
2020-03-26docs/library: Add initial docs for uasyncio module.Damien George
2019-10-23docs: Move ubluetooth under "MicroPython-specific libraries".Mike Wadsten
CPython does not have a bluetooth module, so it is not appropriate to call ubluetooth a Python standard library or micro-library.
2019-10-22docs/library/bluetooth: Rename to "ubluetooth".Jim Mussared
2019-10-22docs/library: Rename "array" module to "uarray".Damien George
2019-10-16docs/library: Clarify relation between machine and port-specific mods.Peter Hinch
2019-10-11docs/library/bluetooth: Add initial BLE documentation.Jim Mussared
2019-09-04docs: Rename machine.ADC docs to machine.ADCWiPy.Damien George
To signify that this ADC documentation is specific to the WiPy, and to make way for a standardised ADC documentation.
2019-01-25docs/library: Add documentation for esp32 module.Damien George
2019-01-25docs: Add initial docs for esp32 port, including quick-ref and general.Matt Trentini
With contributions from Oliver Robson (@HowManyOliversAreThere), Sean Lanigan (@seanlano) and @rprr.
2018-07-31docs: Move WiPy specific Timer class to separate doc file.Damien George
The WiPy machine.Timer class is very different to the esp8266 and esp32 implementations which are better candidates for a general Timer class. By moving the WiPy Timer docs to a completely separate file, under a new name machine.TimerWiPy, it gives a clean slate to define and write the docs for a better, general machine.Timer class. This is with the aim of eventually providing documentation that does not have conditional parts to it, conditional on the port. While the new docs are being defined it makes sense to keep the WiPy docs, since they describe its behaviour. Once the new Timer behaviour is defined the WiPy code can be changed to match it, and then the TimerWiPy docs would be removed.
2018-07-20docs/library/index: Add hint about using help('modules') for discovery.Damien George
2018-07-20docs/library/index: Remove all conditionals from library index.Damien George
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.
2018-06-27docs/ucryptolib: Add docs for new ucryptolib module.Paul Sokolovsky
2018-04-26docs/library: Add ussl module to library index for unix port.Damien George
2017-12-23docs/library/index: Elaborate uPy libraries intro.Paul Sokolovsky
2017-11-10docs/_thread: Add a placeholder docs for _thread module.Paul Sokolovsky
Doesn't list specific API calls yet, the purpose is to let user know that the module exists.
2017-08-22docs: Consistently link to micropython-lib in glossary.Paul Sokolovsky
2017-07-03docs/uerrno: Document "uerrno" module.Paul Sokolovsky
2017-07-01reference/index: Rewrite introduction paragraph to avoid confusion.Paul Sokolovsky
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-06-16docs/select: Rename to uselect, to match the actual module name.Paul Sokolovsky
Also, add ipoll() documentation and markup changes to comply with CPython usage.
2017-05-15docs/library/index: Add important summary of the intro section as warning.Paul Sokolovsky
To make them harder to miss.
2017-04-04docs/library/btree: Add btree module docs.Paul Sokolovsky
2017-03-07docs/library: Add framebuf documentation.Rami Ali
2017-01-23docs: Add documentation for lcd160cr module.Damien George
2016-11-16docs/library/index: Elaborate on u-modules.Paul Sokolovsky
Also, remove an "only" directive in u-modules description.
2016-10-30docs/library/index: Update TOCs so builtins sorted before modules.Paul Sokolovsky
2016-08-07docs/library/index: Include array module in ToC.Paul Sokolovsky
2016-06-09docs/library/index: Add builtins.rst.Paul Sokolovsky
2016-06-02docs/library/index: Fix grammar and spelling in intro paragraph.Damien George
2016-06-02docs/library/index: Add intro paragraph regarding availability of modules.Paul Sokolovsky
This introductions makes explicit the fact that whenever possible, the documentation describes full MicroPython functionality, and arbitrary functions/classes/modules may be missing in a paricular port or build.
2016-05-22docs: esp8266: Include ussl module in the docs.Paul Sokolovsky
2016-05-02docs: _io and _collections were renamed to have standard "u" prefix.Paul Sokolovsky
2016-05-02docs: Add _io module reference.Paul Sokolovsky
2016-05-02docs: Add _collections module reference.Paul Sokolovsky
2016-04-27docs/library: "os" module is actually "uos".Paul Sokolovsky
2016-04-27docs/library/index: Order sections from the most to least standard modules.Paul Sokolovsky
2016-04-27docs/library/index: Make single section for "micro-ified" modules.Paul Sokolovsky
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-27docs/library/index: esp8266 has the same set of stdlibs as pyboard/unix.Paul Sokolovsky
2016-04-27docs/library/index: Move WiPy "micro-libraries" under corresponding heading.Paul Sokolovsky
2016-04-27docs/library: Group MicroPython-specific modules under separate heading.Paul Sokolovsky
2016-04-23docs: esp8266: Include usocket module reference.Paul Sokolovsky
2016-04-22docs/ustruct: There's no complete "struct" module, only "ustruct" subset.Paul Sokolovsky
"ustruct" is good example of micro-ified module, so rather should belong to the corresponding list.
2016-04-07docs: esp8266: Enable "machine" module docs.Paul Sokolovsky
The docs are still heavily biased towards WiPy, so will need a lot of exclusions.
2016-03-25docs: More standard modules for esp8266.Paul Sokolovsky
2016-03-25docs: Add standard modules list for esp8266.Paul Sokolovsky
2015-10-31docs/library/index.rst: Minimally adapt for unix port.Paul Sokolovsky
2015-10-21docs: Add usocket and ussl modules' documentation.danicampora
2015-10-19docs: Add wipy and network.server documentation.danicampora