Damien George
fe45d78b1e
docs: Bump version to 1.9.3.
2017-11-01 11:19:56 +11:00
Paul Sokolovsky
80e3f07e7f
docs/ure: Add "|" (alternative) to the list of supported operators.
2017-10-31 14:46:08 +02:00
Paul Sokolovsky
b81fbf938f
docs/usocket: Document that settimeout() isn't supported by all ports.
...
And describe an alternative of using uselect.poll().
2017-10-31 00:28:28 +02:00
Paul Sokolovsky
4dd523adbb
docs/esp8266/general: Add section on TLS limitations.
2017-10-30 19:50:57 +02:00
Paul Sokolovsky
6fb093282b
docs/ussl: Fix module name refs and use "MicroPython port" term.
2017-10-30 18:03:54 +02:00
Yuval Langer
05a2bb888f
docs/reference/isr_rules: Minor typo correction.
2017-10-30 13:29:00 +11:00
Joar Wandborg
b9923262db
docs/library/network: Add dhcp_hostname parameter
...
I have not actually tested this, going by information available in https://forum.micropython.org/viewtopic.php?t=2584
2017-10-27 11:04:52 +03:00
Paul Sokolovsky
a33fca99a1
docs/usocket: Document inet_ntop(), inet_pton().
2017-10-27 00:27:27 +03:00
Paul Sokolovsky
d1cd533134
docs/usocket: Elaborate descriptions.
...
Use the "usocket" module name everywhere. Use "MicroPython port"
terminology. Suggest to avoid using IPPROTO_* constants in socket()
call.
2017-10-26 14:20:37 +03:00
Paul Sokolovsky
328c1e78be
docs/uselect: Document one-shot polling mode.
2017-10-26 00:30:07 +03:00
Damien George
d90ade5e3e
docs/library/network: Update docs to state that W5500 is supported.
2017-10-16 15:51:56 +11:00
Damien George
65ba481cb0
stm32/modnwwiznet5k: Implement WIZNET5K.isconnected() method.
2017-10-16 13:16:00 +11:00
Mike Causer
b1457db002
docs/library: Add missing cross-ref links for classes in pyb module.
2017-10-11 11:30:16 +11:00
Mike Causer
f599a38059
docs/esp8266/quickref: Add quickref info for RTC class.
2017-10-10 15:22:23 +11:00
Mike Causer
dc92f1c4ee
docs/pyboard/tutorial: Update now that yellow LED also supports PWM.
2017-10-10 15:22:11 +11:00
Mike Causer
d236d0c415
docs/pyboard/quickref: Add info for Switch, RTC, CAN, Accel classes.
2017-10-10 15:22:11 +11:00
Damien George
add933feaf
docs/library/network: Clarify usage of "bssid" arg in connect() method.
2017-10-09 23:11:25 +11:00
Gabe
9e0cdb22f1
docs/esp8266/tutorial: Update neopixel with example of using 4 bbp.
2017-10-04 10:35:22 +11:00
Paul Sokolovsky
72491b3e40
docs/btree: Describe page caching policy of the underlying implementation.
2017-09-17 21:35:33 +03:00
Peter Hinch
d42b89bc3a
docs/library/framebuf.rst: Generalise constructor to all colour formats.
2017-09-13 16:36:57 +10:00
Peter Hinch
da1c80d850
docs/reference/isr_rules.rst Add tutorial on use of micropython.schedule().
2017-09-09 16:05:24 +03:00
Damien George
4a93801c12
all: Update Makefiles and others to build with new ports/ dir layout.
...
Also renames "stmhal" to "stm32" in documentation and everywhere else.
2017-09-06 14:09:13 +10:00
Damien George
fe6f0354f6
docs/library/micropython: Fix typo in RST formatting.
2017-08-29 16:53:30 +10:00
Damien George
e30ba2f1c7
docs/library: Add description of "index" parameter to uos.dupterm().
2017-08-29 16:50:28 +10:00
Paul Sokolovsky
d5336ba136
docs/machine.Signal: Improve style/grammar and add usage example.
2017-08-29 00:08:40 +03:00
Paul Sokolovsky
c5c095690f
docs/library/network: Fix ref to "socket" module (should be "usocket").
2017-08-28 14:00:16 +03:00
Paul Sokolovsky
358a7ba014
docs: More xrefs to "MicroPython port" in glossary.
2017-08-28 13:51:05 +03:00
Damien George
b84268d49c
docs/pyboard/tutorial: Add "timeout=0" to UART in pass-through example.
...
Without this the pass-through will pause for 1 second at each character.
2017-08-23 17:01:43 +10:00
Damien George
1f78e7a431
docs: Bump version to 1.9.2.
2017-08-23 11:46:35 +10:00
Paul Sokolovsky
64a3c52f66
docs: Consistently link to micropython-lib in glossary.
2017-08-22 09:33:31 +03:00
Paul Sokolovsky
387a8d26f9
docs/glossary: Fix typos in micropython-lib paragraph.
2017-08-20 10:44:02 +03:00
Paul Sokolovsky
46583e9057
docs/glossary: Elaborate on possible MicroPython port differences.
...
State that this doc describes generic, "core" MicroPython functionality,
any particular port may diverge in both directions, by both omitting
some functionality, and adding more, both cases described outside the
generic documentation.
2017-08-20 10:11:44 +03:00
Paul Sokolovsky
3f91570483
docs/library/usocket: Describe complete information on address formats.
...
Describe that the only portable way to deal with addresses is by using
getaddrinfo(). Describe that some ports may support tuple addresses using
"socket" module (vs "usocket" of native MicroPython).
2017-08-20 09:49:12 +03:00
Paul Sokolovsky
ccaad53270
docs/library/usocket: Move socket.error to its own section.
...
It's too minor a point to start the module description with it.
2017-08-20 09:04:48 +03:00
Alex Robbins
0aa1d3f447
docs/library/ubinascii: Update base64 docs.
...
This clarifies return values and the handling of invalid (e.g. newline)
characters.
Encoding conforms to RFC 3548, but decoding does not, as it ignores invalid
characters in base64 input. Instead, it conforms to MIME handling of base64
(RFC 2045).
Note that CPython doesn't document handling of invalid characters in
a2b_base64() docs:
https://docs.python.org/3/library/binascii.html#binascii.a2b_base64 , so
we specify it more explicitly than it, based on CPython's actual behavior
(with which MicroPython now compliant).
2017-08-17 09:25:51 +03:00
Javier Candeira
c127ace28a
docs/library/machine.RTC.rst: Fix typo.
2017-08-14 15:42:25 +10:00
Matthew Brener
d003daee06
docs/esp8266/tutorial: Fix typo, "its" to "it's" in powerctrl.rst.
2017-07-24 10:33:03 +10:00
Paul Sokolovsky
205c368fa1
eps8266/general: Fix typo in recent example.
2017-07-21 12:08:18 +03:00
Peter Hinch
6ede921731
eps8266/general: Add known issue of WiFi RX buffers overflow.
2017-07-21 10:19:17 +03:00
Piotr Maliński
8c9e22c127
docs/pyboard/tutorial/amp_skin: Add example for playing large WAV files.
2017-07-21 16:52:16 +10:00
Alexander Steffen
c9a48eb464
docs,teensy: Use the name MicroPython consistently in documentation
2017-07-15 11:44:32 +02:00
Paul Sokolovsky
503cf3d097
docs/uzlib: Update description of decompress() and mention DecompIO.
2017-07-04 02:32:42 +03:00
Damien George
3c62577ee9
docs/pyboard: Move info about using Windows from topindex to general.
2017-07-03 15:31:41 +10:00
Patrick O'Leary
45b127e7ac
docs/esp8266/general.rst: Fix name of NTP module.
...
The simple NTP client module is named "ntptime.py".
2017-07-02 20:02:19 -05:00
Paul Sokolovsky
ffb13cc633
docs/uerrno: Document "uerrno" module.
2017-07-03 00:55:09 +03:00
Paul Sokolovsky
4f23c5d587
docs/pyboard: Move hardware info into General Info chapter.
...
This makes top-level ToC of the pyboard docs consistent with other ports
(consisting of 3 chapters: QuickRef, General Info, and Tutorial).
Also, some other minor tweaks applied, like local ToC for General Info and
headings mentioning pyboard.
2017-07-02 19:23:23 +03:00
Paul Sokolovsky
e467949a4a
docs/*_index: Drop "Indices and tables" pseudo-section.
...
This pseudo-section causes artifacts with latexpdf generation (almost
empty page with list containing literal "genindex", "modeindex", "search"
items). For HTML docs, these sections can be accessed from "home" page.
2017-07-02 19:18:51 +03:00
Paul Sokolovsky
90c1d54464
docs/conf.py: Set "version" and "release" to the same value.
...
We don't use alpha/beta/RC, so for us version and release should be the
same, or it leads to confusion (for example, current, 1.9.1 docs are
marked as 1.9 at places).
2017-07-02 15:50:22 +03:00
Paul Sokolovsky
a6af1a1d9c
docs/replace.inc: Add |see_cpython|, to xref individual symbols from CPython.
...
The idea is to use it for each symbol in builtins.rst.
2017-07-02 15:43:12 +03:00
Paul Sokolovsky
465d84b7e7
docs/library: Add CPython docs xref to each pertinent module.
...
Cross-reference text/link is implemented as RST substitution, so easy to
consistently.
2017-07-02 15:37:31 +03:00
