b1229efbd1
all: Fix spelling mistakes based on codespell check.
...
Signed-off-by: Damien George <damien@micropython.org>
2023-04-27 18:03:06 +10:00
924a3e03ec
top: Replace upip with mip everywhere.
...
Updates all README.md and docs, and manifests to `require("mip")`.
Also extend and improve the documentation on freezing and packaging.
This work was funded through GitHub Sponsors.
Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2022-09-30 17:34:03 +10:00
655c29351a
drivers/display: Don't include tests by default.
...
The tests can be copied to the board if needed.
Also update the docs to reflect this change.
Signed-off-by: Damien George <damien@micropython.org>
2022-09-06 12:09:20 +10:00
d9d67adef1
docs: Remove trailing spaces and convert tabs to spaces.
...
Signed-off-by: Damien George <damien@micropython.org>
2021-12-15 11:49:22 +11:00
e3eebc329f
stm32: Suggest putting code in main.py not boot.py.
...
Don't want users to accidentally use boot.py (because recovering requires
knowing how to activate safe mode).
Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2021-09-16 12:40:05 +10:00
fdd5b18133
docs: Replace master/slave with controller/peripheral in I2C and SPI.
...
See https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names
2021-07-18 11:19:44 +10:00
0054fff840
docs/pyboard: Fix typo in pyb.Switch tutorial.
2021-05-04 23:05:35 +10:00
aec88ddf03
docs: More consistent capitalization and use of articles in headings.
...
See issue #3188 .
2020-01-06 22:17:29 +11:00
90c524c114
docs: Remove spaces on lines that are empty.
2019-12-04 15:02:54 +11:00
a2c4cb484d
docs: Fix spelling in various parts of the docs.
2019-10-16 14:08:28 +11:00
afd10a4531
docs/pyboard: Emphasize the instructions for making a USB mouse.
...
It wasn't clear why that element was `10` instead of `0`. Also bumped the
`10` to `100` to make the mouse movement more obvious.
2019-08-15 18:21:10 +10:00
6592a30f4b
docs/pyboard: Clarify initial files on pyboard and fix up formatting.
2019-08-15 18:01:28 +10:00
57476a3c37
docs/pyboard: Update name of mounted volume to match code.
2019-08-15 17:50:06 +10:00
812969d615
all: Change PYB message prefix to MPY.
...
Replaces "PYB: soft reboot" with "MPY: soft reboot", etc.
Having a consistent prefix across ports reduces the difference between
ports, which is a general goal. And this change won't break pyboard.py
because that tool only looks for "soft reboot".
2019-02-12 15:18:33 +11:00
b3e013f60e
docs: Unify all the ports into one set of documentation.
...
With this commit there is now only one entry point into the whole
documentation, which describes the general MicroPython language, and then
from there there are links to information about specific platforms/ports.
This commit doesn't change content (almost, it does fix a few internal
links), it just reorganises things.
2018-10-01 13:53:53 +10:00
ad4fb62f13
docs/pyboard: Fix to use Sphinx style for internal/external links.
2018-09-20 17:14:13 +10:00
2cff340357
docs/pyboard: For latex build, use smaller quickref jpg, and no gifs.
...
The latexpdf target needs images that fit on the page, and does not support
gifs.
2018-07-10 12:45:52 +10:00
dc92f1c4ee
docs/pyboard/tutorial: Update now that yellow LED also supports PWM.
2017-10-10 15:22:11 +11:00
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
8c9e22c127
docs/pyboard/tutorial/amp_skin: Add example for playing large WAV files.
2017-07-21 16:52:16 +10:00
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
fd860dc552
stmhal: Add .value() method to Switch object, to mirror Pin and Signal.
2017-06-15 17:34:51 +10:00
50a9dd59f5
docs: For LCD160CR driver and tutorial, add link to positioning image.
2017-02-03 12:48:54 +11:00
5ec5bfb0d3
docs/pyboard/tutorial/lcd160cr_skin: Fix typo, get_touched->get_touch.
2017-01-30 18:19:29 +11:00
7d08bc27e2
docs/pyboard/tutorial: Add tutorial for LCD160CR.
2017-01-23 15:50:37 +11:00
f2da6467a9
docs/pyboard: Update USB mouse tutorial to use pyb.USB_HID().
2016-08-29 15:16:51 +10:00
57c92d90b0
docs/pyboard: Update USB mouse tutorial to use VCP instead of CDC.
2016-08-29 15:15:25 +10:00
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +03:00
4a6cac4643
docs: Update asm tutorial, maximum number of allowed args is now 4.
2016-03-17 20:17:40 +00:00
1d191fdf03
docs: Add link from pyboard switch tutorial to ISR rules document.
2016-01-04 16:18:44 +00:00
abfd4da287
docs: Add link from pyboard asm tutorial to asm reference.
2015-06-26 12:35:17 +01:00
2110dc5a6d
docs: Add reference for Thumb2 inline assembler.
...
Thanks to Peter Hinch for contributing this.
2015-06-25 00:21:35 +01: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
7ca1bd314b
docs: Generate a separate docs build for each port.
...
Using Damien's approach where conf.py and topindex.html are
shared by all ports.
2015-06-04 23:44:35 +01:00
Damien George
Jim Mussared
David P
Gabriel M Schuyler
Jason Neal
Damien George
Mike Causer
Vicki Lowe
Piotr Maliński
Paul Sokolovsky
Philip Potter
Peter Hinch
Daniel Campora