7219a18d17
docs/library/index: Update TOCs so builtins sorted before modules.
2016-10-30 23:13:52 +03:00
fdb411a8c5
docs/library/index: Include array module in ToC.
2016-08-07 00:16:41 +03:00
1d3b903eb5
docs/library/index: Add builtins.rst.
2016-06-09 00:26:44 +03:00
ed4e5d2583
docs/library/index: Fix grammar and spelling in intro paragraph.
2016-06-02 11:05:13 +01:00
09f764dc04
docs/library/index: Add intro paragraph regarding availability of modules.
...
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-06-02 00:08:07 +03:00
3e33aeb0db
docs: esp8266: Include ussl module in the docs.
2016-05-22 23:57:26 +03:00
621c644205
docs: _io and _collections were renamed to have standard "u" prefix.
2016-05-02 14:02:54 +03:00
8ebdbcfb27
docs: Add _io module reference.
2016-05-02 00:39:36 +03:00
348caaf940
docs: Add _collections module reference.
2016-05-02 00:36:58 +03:00
351ec6d4ab
docs/library: "os" module is actually "uos".
2016-04-27 01:55:06 +03:00
0df2ee0126
docs/library/index: Order sections from the most to least standard modules.
2016-04-27 01:38:59 +03:00
492bf12499
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-27 01:38:59 +03:00
a119983328
docs/library/index: esp8266 has the same set of stdlibs as pyboard/unix.
2016-04-27 01:17:28 +03:00
88ed518390
docs/library/index: Move WiPy "micro-libraries" under corresponding heading.
2016-04-27 01:14:16 +03:00
8b8c32c09b
docs/library: Group MicroPython-specific modules under separate heading.
2016-04-27 01:11:24 +03:00
bbe5245028
docs: esp8266: Include usocket module reference.
2016-04-23 00:08:11 +03:00
3bc9b571bb
docs/ustruct: There's no complete "struct" module, only "ustruct" subset.
...
"ustruct" is good example of micro-ified module, so rather should belong
to the corresponding list.
2016-04-22 22:37:14 +03:00
9c04299da1
docs: esp8266: Enable "machine" module docs.
...
The docs are still heavily biased towards WiPy, so will need a lot of
exclusions.
2016-04-07 16:44:10 +03:00
6e6488530e
docs: More standard modules for esp8266.
2016-03-25 16:33:05 +02:00
ee6fcc6f91
docs: Add standard modules list for esp8266.
2016-03-25 15:17:55 +02:00
43efb46328
docs/library/index.rst: Minimally adapt for unix port.
2015-10-31 01:15:25 +03:00
04db848dc7
docs: Add usocket and ussl modules' documentation.
2015-10-21 15:30:56 +02:00
36ae417c9f
docs: Add wipy and network.server documentation.
2015-10-19 21:17:15 +02:00
4542643025
docs: Update all WiPy docs to reflect the new API.
2015-10-17 23:29:04 +02:00
05c6fbcae6
esp8266: Fix the documentation for esp.connect() and esp.disconnect()
...
Since the commit that moved those two functions failed to update
the documentation, this is a fix for that.
2015-06-13 23:03:06 +03:00
cfcf47c064
docs: Add initial draft documentation for the WiPy.
...
This makes all common files "port-aware" using the .. only directive.
2015-06-10 23:37:56 +02:00
3eece29807
docs: Change "Micro Python" to "MicroPython" in all places in docs.
2015-06-04 23:53:26 +01:00
78ccb44a90
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-30 12:49:58 +01:00
47098efbda
docs: Provide initial documentation for micropython module.
2015-03-30 00:32:29 +01:00
7a0636e80a
docs: Add initial "uctypes" modules docs. WIP.
2015-01-08 00:17:10 +02:00
adf4c4cea8
docs: Add quick docs for uzlib.
2014-12-05 00:40:35 +02:00
3a5352b483
docs: Add skeleton docs for ure module.
2014-12-04 00:07:00 +02:00
d8fd3103fa
docs: Add quick docs for ubinascii.
2014-12-02 01:51:56 +02:00
d96a916405
docs: Add quick docs for uhashlib.
2014-12-02 00:53:19 +02:00
7f0699eedf
docs: Sort "micro-library" module list alphabetically.
2014-12-01 20:42:38 +02:00
6e6dfdc56b
docs: Make custom index page; add more docs.
2014-11-02 23:37:02 +00:00
88d3054ac0
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-31 01:37:19 +00:00
Paul Sokolovsky
Damien George
danicampora
Radomir Dopieralski