aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2017-10-26docs/uselect: Document one-shot polling mode.Paul Sokolovsky
2017-10-16docs/library/network: Update docs to state that W5500 is supported.Damien George
2017-10-16stm32/modnwwiznet5k: Implement WIZNET5K.isconnected() method.Damien George
2017-10-11docs/library: Add missing cross-ref links for classes in pyb module.Mike Causer
2017-10-10docs/esp8266/quickref: Add quickref info for RTC class.Mike Causer
2017-10-10docs/pyboard/tutorial: Update now that yellow LED also supports PWM.Mike Causer
2017-10-10docs/pyboard/quickref: Add info for Switch, RTC, CAN, Accel classes.Mike Causer
2017-10-09docs/library/network: Clarify usage of "bssid" arg in connect() method.Damien George
2017-10-04docs/esp8266/tutorial: Update neopixel with example of using 4 bbp.Gabe
2017-09-17docs/btree: Describe page caching policy of the underlying implementation.Paul Sokolovsky
2017-09-13docs/library/framebuf.rst: Generalise constructor to all colour formats.Peter Hinch
2017-09-09docs/reference/isr_rules.rst Add tutorial on use of micropython.schedule().Peter Hinch
2017-09-06all: Update Makefiles and others to build with new ports/ dir layout.Damien George
Also renames "stmhal" to "stm32" in documentation and everywhere else.
2017-08-29docs/library/micropython: Fix typo in RST formatting.Damien George
2017-08-29docs/library: Add description of "index" parameter to uos.dupterm().Damien George
2017-08-29docs/machine.Signal: Improve style/grammar and add usage example.Paul Sokolovsky
2017-08-28docs/library/network: Fix ref to "socket" module (should be "usocket").Paul Sokolovsky
2017-08-28docs: More xrefs to "MicroPython port" in glossary.Paul Sokolovsky
2017-08-23docs/pyboard/tutorial: Add "timeout=0" to UART in pass-through example.Damien George
Without this the pass-through will pause for 1 second at each character.
2017-08-23docs: Bump version to 1.9.2.Damien George
2017-08-22docs: Consistently link to micropython-lib in glossary.Paul Sokolovsky
2017-08-20docs/glossary: Fix typos in micropython-lib paragraph.Paul Sokolovsky
2017-08-20docs/glossary: Elaborate on possible MicroPython port differences.Paul Sokolovsky
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-20docs/library/usocket: Describe complete information on address formats.Paul Sokolovsky
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-20docs/library/usocket: Move socket.error to its own section.Paul Sokolovsky
It's too minor a point to start the module description with it.
2017-08-17docs/library/ubinascii: Update base64 docs.Alex Robbins
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-14docs/library/machine.RTC.rst: Fix typo.Javier Candeira
2017-07-24docs/esp8266/tutorial: Fix typo, "its" to "it's" in powerctrl.rst.Matthew Brener
2017-07-21eps8266/general: Fix typo in recent example.Paul Sokolovsky
2017-07-21eps8266/general: Add known issue of WiFi RX buffers overflow.Peter Hinch
2017-07-21docs/pyboard/tutorial/amp_skin: Add example for playing large WAV files.Piotr MaliƄski
2017-07-15docs,teensy: Use the name MicroPython consistently in documentationAlexander Steffen
2017-07-04docs/uzlib: Update description of decompress() and mention DecompIO.Paul Sokolovsky
2017-07-03docs/pyboard: Move info about using Windows from topindex to general.Damien George
2017-07-02docs/esp8266/general.rst: Fix name of NTP module.Patrick O'Leary
The simple NTP client module is named "ntptime.py".
2017-07-03docs/uerrno: Document "uerrno" module.Paul Sokolovsky
2017-07-02docs/pyboard: Move hardware info into General Info chapter.Paul Sokolovsky
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-02docs/*_index: Drop "Indices and tables" pseudo-section.Paul Sokolovsky
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-02docs/conf.py: Set "version" and "release" to the same value.Paul Sokolovsky
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-02docs/replace.inc: Add |see_cpython|, to xref individual symbols from CPython.Paul Sokolovsky
The idea is to use it for each symbol in builtins.rst.
2017-07-02docs/library: Add CPython docs xref to each pertinent module.Paul Sokolovsky
Cross-reference text/link is implemented as RST substitution, so easy to consistently.
2017-07-02docs/conf.py: Add file for global replacements definition.Paul Sokolovsky
The idea is to allow to define a kind of "macros" for repeatitive text, so all occurrances can be updated in one place. Unfortunately, RST doesn't support replacements with arguments, which limits usefulness of them and should be taken into account.
2017-07-02docs/conf.py: Switch to "new" format of intersphinx_mapping.Paul Sokolovsky
As described at http://www.sphinx-doc.org/en/stable/ext/intersphinx.html#confval-intersphinx_mapping This will allow to explicitly refer to CPython docs for cross-references.
2017-07-02docs/topindex.html: Fix typo in "Glossary" heading.Damien George
2017-07-02docs: Add glossary.Paul Sokolovsky
We have enough terms or references throughout the docs which may be not immediately clear or have some important nuances. Referencing terms in gloassary is the best way to deal with that.
2017-07-02docs/ure: Elaborate doc, update markup to the latest conventions.Paul Sokolovsky
2017-07-01docs/builtins: Add AssertionError, SyntaxError, ZeroDivisionError.Paul Sokolovsky
Also, update heading of 1st sections to "Functions and types".
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-07-01docs/differences/index_template: Use consistent heading casing.Paul Sokolovsky
And in our case, "consistent" is where each word in the heading is *not* capitalized.
2017-07-01docs: Move topindex.html to templates/ subdir.Damien George
Later versions of jinja2 need it to be in this subdir, and earlier versions work with it here as well.