Jason Neal
aec88ddf03
docs: More consistent capitalization and use of articles in headings.
See issue #3188 .
5 years ago
Damien George
90c524c114
docs: Remove spaces on lines that are empty.
5 years ago
Mike Causer
a2c4cb484d
docs: Fix spelling in various parts of the docs.
6 years ago
Vicki Lowe
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.
5 years ago
Vicki Lowe
6592a30f4b
docs/pyboard: Clarify initial files on pyboard and fix up formatting.
5 years ago
Vicki Lowe
57476a3c37
docs/pyboard: Update name of mounted volume to match code.
5 years ago
Damien George
e5e472198c
docs/pyboard/quickref: Refer to new machine.I2C instead of old pyb.I2C.
On stm32 boards, machine.I2C is now preferred over pyb.I2C.
6 years ago
johnthagen
ea95bdc1ca
docs/pyboard: Make pyboard v1.1 pinout the default shown in quickref.
6 years ago
johnthagen
d390ad9053
docs/pyboard: Add link to pyboard v1.1 schematic and layout PDF.
6 years ago
Mike Causer
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".
7 years ago
Damien George
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.
6 years ago
Damien George
ad4fb62f13
docs/pyboard: Fix to use Sphinx style for internal/external links.
6 years ago
Damien George
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.
6 years ago
Mike Causer
dc92f1c4ee
docs/pyboard/tutorial: Update now that yellow LED also supports PWM.
7 years ago
Mike Causer
d236d0c415
docs/pyboard/quickref: Add info for Switch, RTC, CAN, Accel classes.
7 years ago
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.
7 years ago
Piotr Maliński
8c9e22c127
docs/pyboard/tutorial/amp_skin: Add example for playing large WAV files.
7 years ago
Damien George
3c62577ee9
docs/pyboard: Move info about using Windows from topindex to general.
7 years ago
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.
7 years ago
Damien George
fd860dc552
stmhal: Add .value() method to Switch object, to mirror Pin and Signal.
8 years ago
Paul Sokolovsky
1ce44f3046
docs/uos: Deconditionalize, remove minor port-specific details.
For a couple of ports, there was information which directory is set
as current after boot. This information doesn't belong to "uos" module,
and is moved to boards' references (which actually already contained
information on which directory is chosen for boot, even if without
explicit mentioning that it becomes current directory, which is now
done).
8 years ago
Damien George
9779c99317
stmhal: Add ability to skip booting from SD card via /flash/SKIPSD file.
8 years ago
Damien George
50a9dd59f5
docs: For LCD160CR driver and tutorial, add link to positioning image.
8 years ago
Damien George
5ec5bfb0d3
docs/pyboard/tutorial/lcd160cr_skin: Fix typo, get_touched->get_touch.
8 years ago
Damien George
7d08bc27e2
docs/pyboard/tutorial: Add tutorial for LCD160CR.
8 years ago
Damien George
e72e343908
docs: Add documentation for lcd160cr module.
8 years ago
Mike Causer
a79f6676c3
docs: Fix some minor spelling mistakes.
paramter -> parameter
send a receive -> send and receive
repsonse -> response
particualr -> particular
constructore -> constructor
8 years ago
puuu
933198c55f
docs/*/quickref.rst: Use new semantics of ticks_diff()
8 years ago
Damien George
efc904c41d
docs/pyboard/quickref: Add section on "delay and timing" for utime mod.
And remove reference to deprecated pyb.delay() and pyb.millis().
8 years ago
Damien George
5c3a2f162e
docs/pyboard/quickref: Add links to pinouts for other pyboard variants.
8 years ago
Philip Potter
f2da6467a9
docs/pyboard: Update USB mouse tutorial to use pyb.USB_HID().
8 years ago
Philip Potter
57c92d90b0
docs/pyboard: Update USB mouse tutorial to use VCP instead of CDC.
8 years ago
Mike Causer
ce166e6b68
docs: Spelling mistakes
8 years ago
Peter Hinch
4a6cac4643
docs: Update asm tutorial, maximum number of allowed args is now 4.
9 years ago
Damien George
1d191fdf03
docs: Add link from pyboard switch tutorial to ISR rules document.
9 years ago
Damien George
abfd4da287
docs: Add link from pyboard asm tutorial to asm reference.
10 years ago
Damien George
2110dc5a6d
docs: Add reference for Thumb2 inline assembler.
Thanks to Peter Hinch for contributing this.
10 years ago
Daniel Campora
ea2cc2b907
docs: Add more documentation for the CC3200 in the pyb module.
10 years ago
Daniel Campora
cfcf47c064
docs: Add initial draft documentation for the WiPy.
This makes all common files "port-aware" using the .. only directive.
10 years ago
Damien George
3eece29807
docs: Change "Micro Python" to "MicroPython" in all places in docs.
10 years ago
Daniel Campora
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.
10 years ago