John Reese
99164a9a13
Pin dependencies to force sphinx 1.8.5
2019-05-11 21:24:39 -07:00
John Reese
63c720bcfb
Include sphinx and recommonmark in docs/requirements.txt
2019-05-11 19:58:10 -07:00
Nicko van Someren
f812394c33
docs/esp32: Correct quickref for ESP32 hardware SPI with non-default IO.
2019-05-10 15:56:13 +10:00
Damien George
34942d0a72
stm32/machine_uart: Change default UART timeout to 0, for non blocking.
...
It's more common to need non-blocking behaviour when reading from a UART,
rather than having a large timeout like 1000ms (the original behaviour).
With a large timeout it's 1) likely that the function will read forever if
characters keep trickling it; or 2) the function will unnecessarily wait
when characters come sporadically, eg at a REPL prompt.
2019-05-07 13:56:42 +10:00
Mike Causer
6323cbda4f
docs/esp8266: Add tutorial for APA102 LEDs.
2019-05-07 11:45:10 +10:00
Yonatan Goldschmidt
ef9843653b
extmod/moducryptolib: Add AES-CTR support.
...
Selectable at compile time via MICROPY_PY_UCRYPTOLIB_CTR. Disabled by
default.
2019-05-06 18:09:48 +10:00
Daniel O'Connor
d4e182039f
docs/cmodules: Note the various ways MODULE_EXAMPLE_ENABLED can be set.
2019-04-18 11:59:43 +10:00
Scott Shawcroft
5f5e456e58
Tweak RTD to install svg2pdfconverter
2019-04-17 18:22:19 -07:00
Daniel O'Connor
fd58136d6b
docs/cmodules: Fix example to globally define MODULE_EXAMPLE_ENABLED.
...
MODULE_EXAMPLE_ENABLED must be globally defined for the module to be seen
and referenced by all parts of the code.
2019-04-15 11:56:22 +10:00
Damien George
0fb15fc3f4
docs/develop: Remove paragraph that was copied in error from other doc.
2019-03-29 11:50:39 +11:00
spacemanspiff2007
95b6330403
docs/esp32: Add example for pin isolation in combination with deepsleep.
2019-03-28 15:25:41 +11:00
brentru
a9e2592425
add weight sensor property to the design guide
2019-03-25 18:10:15 -04:00
Damien George
28c2873d99
docs/esp32: Add a note to quickref about use of Pin.PULL_HOLD.
2019-03-14 07:38:50 +11:00
Damien George
6fa830bfd8
docs/library/machine.Pin: Add PULL_HOLD constant to possible pin pulls.
...
As already mentioned in the docs, not all constants may be available on all
ports, so this is optional to implement.
2019-03-14 07:29:04 +11:00
Martin Fischer
912e957512
docs/develop: Fix typos in C-module example for example_add_ints.
2019-03-13 12:54:01 +11:00
johnthagen
ea95bdc1ca
docs/pyboard: Make pyboard v1.1 pinout the default shown in quickref.
2019-03-13 12:37:35 +11:00
johnthagen
d390ad9053
docs/pyboard: Add link to pyboard v1.1 schematic and layout PDF.
2019-03-13 12:33:02 +11:00
Andrew Leech
89ff506513
py: Update and rework build system for including external C modules.
...
How to use this feature is documented in docs/develop/cmodules.rst.
2019-03-08 22:58:42 +11:00
Ayke van Laethem
2e516074da
py: Implement a module system for external, user C modules.
...
This system makes it a lot easier to include external libraries as static,
native modules in MicroPython. Simply pass USER_C_MODULES (like
FROZEN_MPY_DIR) as a make parameter.
2019-03-08 22:49:00 +11:00
Yonatan Goldschmidt
9521399044
docs/uos: Document extra requirements on stream objs passed to dupterm.
...
This is only correct for the extmod/uos_dupterm.c implementation however,
as e.g cc3200 implementation does the mp_load_method() itself, and anyway
requires `read` instead of `readinto`.
2019-02-26 01:12:37 +11:00
sommersoft
c80e22b6fc
make less vaguer
2019-02-15 18:12:58 -06:00
sommersoft
156b0d286a
dropped the fancy URLs so Sphinx doesn't complain
2019-02-14 23:32:41 -06:00
sommersoft
12ccd5ec55
link to new drivers.rst on the Bundle
2019-02-14 20:45:46 -06:00
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".
2019-02-12 15:18:33 +11:00
Yonatan Goldschmidt
a0d60c574a
docs/ure: Fix match.group signature to indicate index param is required.
2019-02-08 17:06:19 +11:00
Damien George
4dfcc255d5
docs: Convert all cases of machine.sleep to machine.lightsleep.
2019-01-30 14:15:51 +11:00
Damien George
b16146d189
docs/machine: Change sleep to lightsleep and add timeout arguments.
...
The machine.sleep() function can be misleading because it clashes with
time.sleep() which has quite different semantics. So change it to
machine.lightsleep() which shows that it is closer in behaviour to
machine.deepsleep().
Also, add an optional argument to these two sleep functions to specify a
maximum time to sleep for. This is a common operation and underlying
hardware usually has a special way of performing this operation.
The existing machine.sleep() function will remain for backwards
compatibility purposes, and it can simply be an alias for
machine.lightsleep() without arguments. The behaviour will be the same.
2019-01-27 11:12:16 +11:00
Damien George
3e25d611ef
all: Bump version to 1.10.
2019-01-26 00:56:48 +11:00
Damien George
acd647100b
docs/library: Add documentation for esp32 module.
2019-01-25 12:18:34 +11:00
Matt Trentini
69e72954ad
docs: Add initial docs for esp32 port, including quick-ref and general.
...
With contributions from Oliver Robson (@HowManyOliversAreThere), Sean
Lanigan (@seanlano) and @rprr.
2019-01-25 12:18:34 +11:00
Dan Halbert
04aa906fac
fix a few ble-related doc issues
2019-01-24 00:13:15 -05:00
Roy Hooper
ffe734edf7
Fresh combined checkin of _pixelbuf library.
2019-01-13 23:51:13 -05:00
stijn
5064df2074
docs/differences: Clarify the differences are against Python 3.4.
2019-01-11 12:11:02 +11:00
Dan Halbert
4167bf5b24
wip: advertising works, but not connection
2018-12-27 00:04:04 -05:00
Paul Sokolovsky
169b152f29
docs/ure: Fully describe supported syntax subset, add example.
2018-12-13 01:16:30 +11:00
Damien George
beeeec292b
docs/README: Remove references to MICROPY_PORT when building docs.
...
The docs are now built as one for all ports.
2018-12-11 02:55:22 +11:00
sommersoft
4254ae6d5b
add 74HC595
2018-11-21 13:05:02 -06:00
sommersoft
59430ea26d
fix L3GD20 link
2018-11-21 12:58:11 -06:00
sommersoft
d7aa790e4b
add trailing '/' to links missing them
2018-11-21 12:55:01 -06:00
sommersoft
e2bfe91700
i have no more words...
2018-11-13 23:37:27 -06:00
sommersoft
c669f7563c
git diff review fail before push...
2018-11-13 23:32:50 -06:00
sommersoft
a7a66e9399
fix led-animation url; it has 2 valid urls...
2018-11-13 23:28:23 -06:00
sommersoft
b68517fbab
replaced scrubbed drivers
2018-11-13 23:24:53 -06:00
sommersoft
028915d6f7
update /docs/drivers.rst page; 19 drivers added
2018-11-13 19:45:11 -06:00
Paul Sokolovsky
42d0a28117
docs/conf.py: Use https for intersphinx link to docs.python.org.
...
To get rid of warning when building the docs saying there's a redirect from
http: to https:.
2018-10-23 11:47:35 +11:00
Paul Sokolovsky
dd76c8dc0f
docs/library/uctypes: Add examples and make general updates.
...
Examples are added to the beginning of the module docs, similarly to docs
for many other modules.
Improvements to grammar, style, and clarity. Some paragraphs are updated
with better suggestions. A warning added of the effect incorrect usage of
the module may have. Describe the fact that offset range used in one
defined structure is limited.
2018-10-23 11:42:30 +11:00
Dave Hylands
b031b6f4dd
docs/pyb.Pin: Minor typo fix to specify Pin in pyb.Pin.cpu.
2018-10-19 17:31:59 +11:00
Paul Sokolovsky
5f7088f84d
docs/uio: Document StringIO/BytesIO(alloc_size) constructors.
2018-10-18 12:39:25 +11:00
Peter Hinch
759853f2a1
docs/machine.Pin: Document "hard" argument of Pin.irq method.
2018-10-15 00:17:54 +11:00
Peter Hinch
7de9211b80
docs/machine.Pin: Add note regarding irq handler argument.
2018-10-13 16:25:42 +11:00