summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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-08Update pwm.rstAlex Vasylenko
replace reference to non-existent `time.sleep_ms()`
2017-10-04docs/esp8266/tutorial: Update neopixel with example of using 4 bbp.Gabe
2017-09-22Move to ASF4 and introduce SAMD51 support. (#258)3.0.0-alpha.0Scott Shawcroft
* atmel-samd: Remove ASF3. This will break builds. * atmel-samd: Add ASF4 for the SAMD21 and SAMD51. * Introduce the supervisor concept to facilitate porting. The supervisor is the code which runs individual MicroPython VMs. By splitting it out we make it more consistent and easier to find. This also adds very basic SAMD21 and SAMD51 support using the supervisor. Only the REPL currently works. This begins the work for #178.
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-07updated the http reference for max7219 to use the readthedocs from the ↵2.0.0stablemrmcwethy
adafruit cirtcuitpython area instead of the micropython area
2017-09-06Added DotStar to line 722.0.0-rc.2KurticusMaximus
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-09-05Add a micropython section and edit drivers docCarol Willing
2017-09-01Style tweaks based on @willingc's feedback.2.0.0-rc.1Scott Shawcroft
2017-09-01docs: Add beginnings of troubleshooting doc.Scott Shawcroft
Fixes #172. Related to #214.
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-25Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in ↵Dan Halbert
development) master. cpx build compiles and loads and works in repl; test suite not run yet esp8266 not tested yet
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.v1.9.2Damien 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-16Update docs README to mention requirement for recommonmark dependency.Tony DiCola
2017-08-14docs/library/machine.RTC.rst: Fix typo.Javier Candeira
2017-08-07docs: Add link to SD card driver.Scott Shawcroft
2017-07-28Update favicon to blinka.Scott Shawcroft
2017-07-28docs: Add links to NeoPixel and SimpleIO docs.Scott Shawcroft
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-19docs: Minor updates before 1.0.0Scott Shawcroft
2017-07-15docs,teensy: Use the name MicroPython consistently in documentationAlexander Steffen
2017-07-14docs: tweak css so a horizontal scroll bar shows up on the wide pinout ↵Scott Shawcroft
tables. Fixes #166
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.