3c50098dfc
add stm32f4 to docs
2020-02-06 15:17:42 -05:00
83439e38fc
unix/main: Add command-line -h option for printing help text.
...
This adds a -h option to print the usage help text and adds a new, shorter
error message that is printed when invalid arguments are given. This
behaviour follows CPython (and other tools) more closely.
2020-02-04 17:54:31 +11:00
c8d2f7838f
docs/unix: Add a new new quickref page for the UNIX port.
...
This adds a new quickstart page for the UNIX port that documents the
command line options and environment variables.
2020-02-04 17:53:06 +11:00
c4ea4c1810
docs/esp8266: In TCP tutorial, add HTTP response code and content-type.
...
Show how to send an HTTP response code and content-type. Without the
response code Safari/iOS will fail. Without the content-type Lynx/Links
will fail.
2020-02-03 23:50:09 +11:00
a55c17dc69
esp32/modnetwork: Add max_clients kw-arg to WLAN.config for AP setting.
...
This allows the user to configure the maximum number of clients that are
connected to the access point. Resolves #5125 .
2020-01-22 16:43:25 +11:00
59746ac14a
docs/library/uos.rst: Improve block devices section, and ioctl ret vals.
2020-01-22 16:37:31 +11:00
ed2d94cae9
Merge pull request #2543 from pewpew-game/support-matrix
...
Fix entry overrides in support matrix generation
2020-01-21 18:18:08 -06:00
e1840f6abc
Fix entry overrides in support matrix generation
...
Fix #2539
The entries in the board's mpconfigboard.mk override any other entries.
Also, fixed a warning for bad use of backslash in a string.
2020-01-21 22:03:47 +01:00
7ef2f65114
docs/library: Add / to indicate positional-only args in library docs.
...
Removes the confusion of positional-only arguments which have defaults that
look like keyword arguments.
2020-01-12 13:44:59 +11:00
1caede927a
docs/library/machine: Document machine.soft_reset() function.
2020-01-12 13:38:27 +11:00
bc5c993adf
docs/README: Add short paragraph about using readthedocs.
...
This adds a short paragraph on how to hook readthedocs.org up. The main
goal is to make people aware of the option, to help with contributing to
the documentation.
2020-01-12 11:45:55 +11:00
13e0cba6f1
Add initial MIMXRT10XX port
2020-01-06 21:08:49 +01:00
5ef3b6b2d9
docs/library/machine.UART.rst: Detail timeout behaviour of read methods.
...
Also document existence of "invert" argument to constructor.
2020-01-06 22:50:58 +11:00
99ed431d28
docs/library/machine.I2C.rst: Use positional-only arguments syntax.
...
Addresses issue #5196 .
2020-01-06 22:25:35 +11:00
aec88ddf03
docs: More consistent capitalization and use of articles in headings.
...
See issue #3188 .
2020-01-06 22:17:29 +11:00
1f37194730
all: Bump version to 1.12.
2019-12-20 16:58:17 +11:00
7f235cbee9
docs/esp32: Add quickref and full docs for esp32.RMT class.
2019-12-20 12:25:38 +11:00
8449e41818
docs/develop: Add documentation on how to build native .mpy modules.
2019-12-19 17:07:53 +11:00
e58c7ce3d6
docs/reference: Add documentation describing use of .mpy files.
...
Including information about .mpy versioning and how to debug failed imports
of .mpy files.
2019-12-19 17:06:27 +11:00
04e7aa0563
docs/esp8266/quickref: Add note that machine.RTC is not fully supported.
...
See issues #3220 and #3710 .
2019-12-17 12:19:27 +11:00
f3f7eb48da
docs/library/uos.rst: Clarify why the extended interface exists.
2019-12-16 12:45:15 +11:00
cca42e94d7
Add to BUILDING to table of contents.
2019-12-14 15:00:42 -05:00
b310930dba
docs/library/uos: Add notes and links about littlefs failures.
2019-12-10 16:58:53 +11:00
159388f850
docs/library/ubluetooth: Add note about API being under development.
2019-12-10 16:58:27 +11:00
381be9a745
docs/reference/filesystem: Add note and example about using filesystem.
2019-12-09 14:21:22 +11:00
50dc5f10a6
docs/reference/filesystem: Fix typo in block device code example.
2019-12-09 14:13:09 +11:00
84958a8fe1
extmod/modbluetooth: Allow setting ringbuf size via BLE.config(rxbuf=).
...
The size of the event ringbuf was previously fixed to compile-time config
value, but it's necessary to sometimes increase this for applications that
have large characteristic buffers to read, or many events at once.
With this commit the size can be set via BLE.config(rxbuf=512), for
example. This also resizes the internal event data buffer which sets the
maximum size of incoming data passed to the event handler.
2019-12-05 11:30:35 +11:00
7aeafe2ae9
extmod/modbluetooth: Add optional 4th arg to gattc_write for write mode.
...
This allows the user to explicitly select the behaviour of the write to the
remote peripheral. This is needed for peripherals that have
characteristics with WRITE_NO_RESPONSE set (instead of normal WRITE). The
function's signature is now:
BLE.gattc_write(conn_handle, value_handle, data, mode=0)
mode=0 means write without response, while mode=1 means write with
response. The latter was the original behaviour so this commit is a change
in behaviour of this method, and one should specify 1 as the 4th argument
to get back the old behaviour.
In the future there could be more modes supported, such as long writes.
2019-12-04 23:23:07 +11:00
9a849cc7ca
docs: Add littlefs docs and a filesystem tutorial.
2019-12-04 23:18:23 +11:00
f2650be844
docs/library: Add docs for pyb.Flash class.
2019-12-04 23:18:17 +11:00
d7dbd267e7
docs/reference: Add docs describing use of pyboard.py.
2019-12-04 23:18:03 +11:00
90c524c114
docs: Remove spaces on lines that are empty.
2019-12-04 15:02:54 +11:00
e873d352ad
extmod/modbluetooth: Simplify management of pre-allocated event data.
...
The address, adv payload and uuid fields of the event are pre-allocated by
modbluetooth, and reused in the IRQ handler. Simplify this and move all
storage into the `mp_obj_bluetooth_ble_t` instance.
This now allows users to hold on to a reference to these instances without
crashes, although they may be overwritten by future events. If they want
to hold onto the values longer term they need to copy them.
2019-11-25 17:32:10 +11:00
d667bc642f
docs/library/ubluetooth: Fix name and link to FLAG_xxx constants.
2019-11-12 15:15:12 +11:00
d30b75e8f2
docs/library/machine.SDCard.rst: Fix various typos.
2019-11-07 14:47:11 +11:00
59850c0b83
docs/templates/topindex.html: Replace usage of deprecated defindex.html.
...
defindex.html (used by topindex.html) is deprecated, but topindex.html was
already identical other than setting the title, so just inherit directly
from layout.html.
2019-11-07 14:45:55 +11:00
1295146a6f
docs/conf.py: Fix path to favicon.ico.
2019-11-07 14:45:34 +11:00
ca3d4c84e4
docs/library/ubluetooth: Add docs for gatts_set_buffer.
2019-10-29 23:11:11 +11:00
7a24b7f091
docs/library: Add documentation for extended block device protocol.
2019-10-29 14:17:29 +11:00
f69ef97f24
docs: Move ubluetooth under "MicroPython-specific libraries".
...
CPython does not have a bluetooth module,
so it is not appropriate to call ubluetooth
a Python standard library or micro-library.
2019-10-23 11:43:01 -05:00
19e87742c4
docs/library/bluetooth: Rename to "ubluetooth".
2019-10-22 21:58:05 +11:00
a2eea57b1d
docs/library: Rename "array" module to "uarray".
2019-10-22 16:40:58 +11:00
615d6b3c66
docs/wipy/tutorial: Link Blynk examples to the official library.
2019-10-16 14:20:31 +11:00
a2c4cb484d
docs: Fix spelling in various parts of the docs.
2019-10-16 14:08:28 +11:00
5a8f392f09
docs/esp8266: Add ntptime usage to esp8266 quickref.
2019-10-16 14:08:13 +11:00
c0b3419261
docs/library: Clarify relation between machine and port-specific mods.
2019-10-16 14:03:44 +11:00
5463ab6df6
docs/esp8266/tutorial: Make http_get sample function self contained.
2019-10-16 13:52:04 +11:00
d1ed73ca8f
docs/library/bluetooth.rst: Fix typo in HR/UART services example.
2019-10-16 11:23:54 +11:00
36502bdfdc
extmod/modbluetooth: Make gap_disconnect not raise when disconnected.
...
Previously it raised OSError(MP_ENOTCONN) if the conn_handle was already
disconnected. Now it returns True/False.
2019-10-15 17:22:53 +11:00
ea315d7d58
docs/library/bluetooth.rst: Explain how to increase char buffer size.
2019-10-15 17:22:45 +11:00
62e3a966fb
docs/library/bluetooth.rst: Clarify gap_advertise adv_data behavior.
...
Make it clear that the previous adv_data will be reused if it's not set.
And some minor other improvements.
2019-10-15 17:21:32 +11:00
a93495b66d
docs/reference/glossary.rst: Add new terms and reduce complexity of old.
2019-10-15 16:36:02 +11:00
615ec7f74d
merge from upstream
2019-10-14 18:12:58 -04:00
f14fbd4aab
update docs/supported_ports.rst
2019-10-13 19:39:42 -04:00
1fa8841d20
Change port name to cxd56
2019-10-11 08:23:51 +02:00
dc82bee298
docs/library/bluetooth: Add initial BLE documentation.
2019-10-11 14:03:01 +11:00
0a48282e51
Add Spresense to supported_ports
2019-10-09 13:11:22 +02:00
4ddd46e6cf
docs/develop/qstr.rst: Add documentation for string interning.
2019-10-04 17:13:13 +10:00
01ec3b995e
use 'any()' vs 'len == 1 & == False'
2019-10-02 00:02:49 -05:00
c3dda7c535
add parsing for 'MINIMAL/DEFAULT'; process inclusion when determined by another module
2019-09-27 23:41:34 -05:00
78e0e76b4f
docs/library/pyb.USB_VCP.rst: Add info about id and flow params.
2019-09-26 14:00:21 +10:00
cb84e22ac6
docs/library/pyb.rst: Update pyb.usb_mode() to mention VCP+MSC+HID.
2019-09-11 15:17:38 +10:00
50636e5296
docs/library/pyb.rst: Update docs for pyb.usb_mode() function.
2019-09-10 13:22:35 +10:00
e509da22df
docs/library: Specify new machine.ADC class.
...
This initial specification is only for the ADC constructor and read_u16()
method.
2019-09-04 15:35:09 +10:00
8a237237a3
docs: Rename machine.ADC docs to machine.ADCWiPy.
...
To signify that this ADC documentation is specific to the WiPy, and to make
way for a standardised ADC documentation.
2019-09-04 15:05:03 +10:00
74fe841449
docs/library/pyb.DAC.rst: Correct frequency for triangle mode output.
...
Also correct comments in related code.
2019-09-03 23:25:45 +10:00
afc8596c15
docs/reference/speed_python: Add missing self to var caching example.
2019-08-28 12:55:41 +10:00
05eb897d06
esp32: Add esp32.Partition class to expose partition and OTA funcs.
...
Partitions are exposed as a standard MicroPython block device.
2019-08-20 16:49:18 +10:00
3a679eaf00
docs/reference/speed_python: Update that read-only buffers are accepted.
...
As allowed by recent cd35dd9d9a
2019-08-19 16:39:30 +10: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
d5a7741606
docs/library: Document that sys.version_info returns a 3-tuple only.
...
See issue #4970 .
2019-08-15 18:12:22 +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
ed9c0185d8
docs/library/sys: Add documentation for sys.atexit function.
2019-08-15 17:42:38 +10:00
00e7fe8ab1
docs/library/framebuf: Add missing module reference in example code.
2019-07-31 23:45:24 +10:00
8c75962850
add ':noindex:' to micropy's 'network.rst' to avoid sphinx conflict
2019-07-28 16:00:29 -05:00
d489c7a057
change 'c2rst' from source_parser -> extension; allows use of sphinx 2.x
2019-07-28 15:59:26 -05:00
143275db04
fix board_exclusion lookup
2019-07-27 11:01:10 -05:00
69bbdcab91
use MICROPY_HW_BOARD_NAME vice board's folder name
2019-07-27 10:30:57 -05:00
c6ac0ba683
move the support matrix to its own page; add linking for modules
2019-07-27 10:03:18 -05:00
a184380dc9
add port-wide config parsing; add modules-by-board function
2019-07-27 09:15:37 -05:00
b90b63bb2b
don't use files to pass data; call and return directly in conf.py
2019-07-23 20:49:37 -05:00
a29334761d
esp32: Add support for hardware I2C.
2019-07-19 16:31:25 +10:00
bc66fe9064
py/scheduler: Rename sched_stack to sched_queue.
...
Behaviour was changed from stack to queue in
8977c7eb58
2019-07-17 16:09:32 +10:00
fce1efc74c
more python3.5 compatibility fixes
2019-07-07 09:14:46 -05:00
86e885c5fc
handle module exclusion when the default is to not include a module
2019-07-05 18:00:26 -05:00
7378744bb2
update regex module use to be python3.5 compatible
2019-07-05 16:11:19 -05:00
42ed84141e
fix late-night directory snafu
2019-07-04 01:49:40 -05:00
4342383d95
add jinja extension; update shared-bindings/index.rst to use jinja
2019-07-04 01:19:56 -05:00
f1256c0b35
add script to gather module support matrix info; add initial json file
2019-07-04 01:18:16 -05:00
48443c9c3f
Update import statement in code snippet.
...
The code snippets in the Design Guide article reference without the statement.
2019-06-25 08:36:44 -04:00
0bb92d4fc3
Fix references to cpython in builtins documentation.
2019-06-18 16:59:05 -05:00
1a51fc9ddf
esp32/machine_sdcard: Fix bug in SPI slot number selection.
...
And fix minor typo in docs when referring to SDCard class.
2019-06-17 12:36:22 +10:00
6077d17150
docs/machine: Add initial docs for new machine.SDCard class.
2019-06-03 00:42:24 +10:00
6f75c4f3cd
all: Bump version to 1.11.
2019-05-29 16:38:10 +10:00
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.
2019-05-20 15:46:01 +10:00
8bec0e869d
docs/machine.I2C: Add writevto method to write a vector of byte bufs.
...
This allows to efficiently send to an I2C slave data that is made up of
more than one buffer. Instead of needing to allocate temporary memory to
combine buffers together this new method allows to pass in a tuple or list
of buffers. The name is based on the POSIX function writev() which has
similar intentions and signature.
The reasons for taking this approach (compared to having an interface with
separate start/write/stop methods) are:
- It's a backwards compatible extension.
- It's convenient for the user.
- It's efficient because there is only one Python call, then the C code can
do everything in one go.
- It's efficient on the I2C bus because the implementation can do
everything in one go without pauses between blocks of bytes.
- It should be possible to implement this extension in all ports, for
hardware and software I2C.
Further discussion is found in issue #3482 , PR #4020 and PR #4763 .
2019-05-20 14:51:56 +10:00
99164a9a13
Pin dependencies to force sphinx 1.8.5
2019-05-11 21:24:39 -07:00
63c720bcfb
Include sphinx and recommonmark in docs/requirements.txt
2019-05-11 19:58:10 -07:00
f812394c33
docs/esp32: Correct quickref for ESP32 hardware SPI with non-default IO.
2019-05-10 15:56:13 +10:00
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
6323cbda4f
docs/esp8266: Add tutorial for APA102 LEDs.
2019-05-07 11:45:10 +10:00
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
d4e182039f
docs/cmodules: Note the various ways MODULE_EXAMPLE_ENABLED can be set.
2019-04-18 11:59:43 +10:00
5f5e456e58
Tweak RTD to install svg2pdfconverter
2019-04-17 18:22:19 -07:00
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
0fb15fc3f4
docs/develop: Remove paragraph that was copied in error from other doc.
2019-03-29 11:50:39 +11:00
95b6330403
docs/esp32: Add example for pin isolation in combination with deepsleep.
2019-03-28 15:25:41 +11:00
a9e2592425
add weight sensor property to the design guide
2019-03-25 18:10:15 -04:00
28c2873d99
docs/esp32: Add a note to quickref about use of Pin.PULL_HOLD.
2019-03-14 07:38:50 +11:00
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
912e957512
docs/develop: Fix typos in C-module example for example_add_ints.
2019-03-13 12:54:01 +11:00
ea95bdc1ca
docs/pyboard: Make pyboard v1.1 pinout the default shown in quickref.
2019-03-13 12:37:35 +11:00
d390ad9053
docs/pyboard: Add link to pyboard v1.1 schematic and layout PDF.
2019-03-13 12:33:02 +11:00
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
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
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
c80e22b6fc
make less vaguer
2019-02-15 18:12:58 -06:00
156b0d286a
dropped the fancy URLs so Sphinx doesn't complain
2019-02-14 23:32:41 -06:00
12ccd5ec55
link to new drivers.rst on the Bundle
2019-02-14 20:45:46 -06: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
a0d60c574a
docs/ure: Fix match.group signature to indicate index param is required.
2019-02-08 17:06:19 +11:00
4dfcc255d5
docs: Convert all cases of machine.sleep to machine.lightsleep.
2019-01-30 14:15:51 +11:00
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
3e25d611ef
all: Bump version to 1.10.
2019-01-26 00:56:48 +11:00
acd647100b
docs/library: Add documentation for esp32 module.
2019-01-25 12:18:34 +11:00
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
04aa906fac
fix a few ble-related doc issues
2019-01-24 00:13:15 -05:00
ffe734edf7
Fresh combined checkin of _pixelbuf library.
2019-01-13 23:51:13 -05:00
5064df2074
docs/differences: Clarify the differences are against Python 3.4.
2019-01-11 12:11:02 +11:00
4167bf5b24
wip: advertising works, but not connection
2018-12-27 00:04:04 -05:00
169b152f29
docs/ure: Fully describe supported syntax subset, add example.
2018-12-13 01:16:30 +11:00
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
4254ae6d5b
add 74HC595
2018-11-21 13:05:02 -06:00
59430ea26d
fix L3GD20 link
2018-11-21 12:58:11 -06:00
d7aa790e4b
add trailing '/' to links missing them
2018-11-21 12:55:01 -06:00
e2bfe91700
i have no more words...
2018-11-13 23:37:27 -06:00
c669f7563c
git diff review fail before push...
2018-11-13 23:32:50 -06:00
a7a66e9399
fix led-animation url; it has 2 valid urls...
2018-11-13 23:28:23 -06:00
b68517fbab
replaced scrubbed drivers
2018-11-13 23:24:53 -06:00
028915d6f7
update /docs/drivers.rst page; 19 drivers added
2018-11-13 19:45:11 -06:00
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
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
b031b6f4dd
docs/pyb.Pin: Minor typo fix to specify Pin in pyb.Pin.cpu.
2018-10-19 17:31:59 +11:00
5f7088f84d
docs/uio: Document StringIO/BytesIO(alloc_size) constructors.
2018-10-18 12:39:25 +11:00
759853f2a1
docs/machine.Pin: Document "hard" argument of Pin.irq method.
2018-10-15 00:17:54 +11:00
7de9211b80
docs/machine.Pin: Add note regarding irq handler argument.
2018-10-13 16:25:42 +11:00
f5d46a88aa
lib/utils/pyexec: Forcefully unlock the heap if locked and REPL active.
...
Otherwise there is really nothing that can be done, it can't be unlocked by
the user because there is no way to allocate memory to execute the unlock.
See issue #4205 and #4209 .
2018-10-13 16:21:08 +11:00
5bb12793a0
update documentation and translations again
2018-10-11 22:19:46 +11:00
d251f26688
docs/uselect: Describe more aspects of poll.register/modify behavior.
...
E.g., register() can be called again for the same object, while modify()
will raise exception if object was not register()ed before.
2018-10-05 16:57:58 +10:00
86819a52fe
docs/wipy: Fix links to network.Server, and markup for boot.py.
2018-10-01 14:08:02 +10:00
d1adfee251
docs: Remove sphinx_selective_exclude, it's no longer used.
2018-10-01 13:54:32 +10: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
8a84e08dc8
docs/library/network: Make AbstractNIC methods layout correctly.
2018-09-27 17:24:41 +10:00
217566b764
docs/library/network: Move specific network classes to their own file.
...
All concrete network classes are now moved to their own file (eg
network.WLAN.rst) and deconditionalised (remove ..only:: directives). This
makes the network documentation the same for all ports. After this change
there are no more "..only::" directives for different ports, and the only
difference among ports is the very front page of the docs.
2018-09-27 17:23:42 +10:00
09c5c58a1f
docs/library/machine.SPI: Add note about baudrate imprecision.
2018-09-26 15:21:10 +10:00
ad4fb62f13
docs/pyboard: Fix to use Sphinx style for internal/external links.
2018-09-20 17:14:13 +10:00
927a5d1dfd
docs/library/pyb: Add deprecation warning for mount and old block proto.
...
pyb.mount(None, mountpoint) functionality is also removed and replaced by
uos.umount.
2018-09-20 16:31:36 +10:00
12e2a26406
Add new drivers to the doc page
2018-09-07 15:19:37 -07:00
b18fa1e606
docs/library/machine.UART.rst: Specify optional txbuf and rxbuf args.
...
If a port would like to expose the configuration of transmit and/or receive
buffers then it can use these arguments.
2018-08-14 15:21:54 +10:00
163bacd1e8
docs/library/machine.I2C.rst: Clarify availability of primitive I2C ops.
2018-08-04 15:53:12 +10:00
d8e0320485
docs: Move WiPy specific Timer class to separate doc file.
...
The WiPy machine.Timer class is very different to the esp8266 and esp32
implementations which are better candidates for a general Timer class. By
moving the WiPy Timer docs to a completely separate file, under a new name
machine.TimerWiPy, it gives a clean slate to define and write the docs for
a better, general machine.Timer class. This is with the aim of eventually
providing documentation that does not have conditional parts to it,
conditional on the port.
While the new docs are being defined it makes sense to keep the WiPy docs,
since they describe its behaviour. Once the new Timer behaviour is defined
the WiPy code can be changed to match it, and then the TimerWiPy docs would
be removed.
2018-07-31 23:40:06 +10:00
0a02d77d64
Comment that it may vary by board
2018-07-30 15:20:12 -07:00
76971d9907
Wordsmith
...
For #1067
2018-07-30 15:04:40 -07:00
c76a4d477f
remove qemu-arm build; fix docs build bugs
2018-07-29 16:47:06 -04:00
bc760dd341
WIP: complete manual inspection of all significant changes
2018-07-23 21:34:25 -04:00
81e320aecc
docs/library/machine: Remove conditionals in machine class index.
...
The machine module should be standard across all ports so should have the
same set of classes in the docs. A special warning is added to the top of
the machine.SD class because it is not standardised and only available on
the cc3200 port.
2018-07-20 15:58:18 +10:00
0ab8428995
docs/reference/index: Remove conditional for inline asm docs.
...
The heading of this section makes it clear it is for Thumb-2 architectures
only.
2018-07-20 15:51:06 +10:00
5b1ca66668
docs/library/index: Add hint about using help('modules') for discovery.
2018-07-20 15:47:42 +10:00
84d5dd46fe
docs/library/index: Remove all conditionals from library index.
...
It's fair to just provide a link to all available modules, regardless of
the port. Most of the existing ports (unix, stm32, esp8266, esp32) share
most of the same set of modules anyway, so no need to maintain separate
lists for them. And there's a big discussion at the start of this index
about modules not being available on a given port.
For port-specific modules, they can also be listed unconditionally because
they have headings that explicitly state they are only available on certain
ports.
2018-07-20 15:34:22 +10:00
3e0d587a49
docs/library/machine: Remove conditional docs for rng function.
...
And instead list its availability explicitly.
2018-07-18 16:28:30 +10:00
163cc66a0b
docs/library/machine: Remove conditional docs for wake_reason function.
...
And instead list its availability explicitly.
2018-07-18 16:23:34 +10:00
4cc65e22d4
docs/library/machine.UART: Remove conditional docs for wipy port.
...
The UART.init() method is now included unconditionally and its wording
adjusted to better describe ports other than the cc3200.
UART.irq() is also included unconditionally, but this is currently only
available on the WiPy target.
2018-07-18 16:20:53 +10:00
164377f806
docs/library/pyb.DAC: Fix typo in markup to balance quotes.
2018-07-18 15:52:48 +10:00
805fd0cfe6
docs/library: Remove "only" directive from all pyb module docs.
...
By virtue of its name, the pyb module would only be available on a pyboard
and so does not need to have conditional "only" directives throughout its
documentation.
These conditionals were added mostly in
cfcf47c0644542643025
2018-07-18 15:47:44 +10:00
2809b4f9dd
Merge branch 'master' into micropython-25ae98f-merge
2018-07-16 19:36:40 -04:00
a20ab40ed2
Merge 3.0.0 final bugfixes and changes to master
2018-07-16 09:01:46 -04:00
7c219600a2
WIP: after merge; before testing
2018-07-11 16:45:30 -04: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
41226e9a18
docs/ure: Document some more supported regex operators.
2018-07-02 14:55:05 +10:00
4727bd1db8
docs/ure: Document sub(), groups(), span(), start() and end().
2018-07-02 14:55:05 +10:00
ab02abe96d
docs/uos: Make it clear that block device block_num param is an index.
2018-06-28 13:25:10 +10:00
473fe45da2
extmod/moducryptolib: Optionally export MODE_* constants to Python.
...
Allow including crypto consts based on compilation settings. Disabled by
default to reduce code size; if one wants extra code readability, can
enable them.
2018-06-27 16:29:26 +10:00
11a7a70a6f
docs/usocket: Minor fixes to grammar of getaddrinfo.
2018-06-27 15:18:46 +10:00
2e3468a68c
docs/usocket: getaddrinfo: Describe af/type/proto optional params.
...
These can be optionally specified, but all ports are expected to be able to
accept them, at the very least ignore, though handling of "type" param
(SOCK_STREAM vs SOCK_DGRAM) is recommended.
2018-06-27 14:57:19 +10:00
12fde67a25
docs/ucryptolib: Add docs for new ucryptolib module.
2018-06-27 14:57:11 +10:00
b9ec6037ed
docs/library: Add documentation for ucollections.deque.
2018-06-26 14:29:22 +10:00
5731e535dd
docs/esp8266: Fix minor typo in "certificates".
2018-06-25 17:36:28 +10:00
8e6feecf11
Merge pull request #863 from dhalbert/3.0_doc_updates
...
RTD documentation updates
2018-05-23 12:57:34 -07:00
bbdca2f352
typos in builtins.rst
2018-05-23 15:07:32 -04:00
6a63ff096a
ustruct -> struct in design_guide.rst
2018-05-23 15:05:38 -04:00
27551cbb4d
Fix ReadTheDocs build due to c2rst.
2018-05-23 11:53:00 -07:00
079c20e58e
use shared-bindings struct doc; remove docs/library one
2018-05-23 14:24:02 -04:00
20a13fa9fb
fix title underline
2018-05-22 21:21:19 -04:00
59615fc993
add caveat language re MicroPython libraries; other slight changes
2018-05-22 20:49:08 -04:00
e65cc07764
RTD documentation updates
2018-05-22 19:52:01 -04:00
6c955932f3
stm32/rtc: Don't try to set SubSeconds value on RTC.
...
The hardware doesn't allow it, instead the value is reset to 255 upon
setting the other calendar/time values.
2018-05-21 14:08:37 +10:00
90a09dba59
Merge branch 'master' of github.com:adafruit/circuitpython
2018-05-15 14:54:54 -04:00
567f3e30a7
Initial implementation of supervisor.reload()
2018-05-14 16:57:50 -04:00
321f882b6c
Merge pull request #834 from khawley/docs-makefile-fixes
...
Cleaning up and fixing the docs generation Makefile and README instructions
2018-05-14 16:09:39 -04:00
2ff7148d09
Update docs s/ucollections/collections/g
2018-05-14 14:31:56 -04:00
f9ae1ee172
Cleaning up and fixing the docs generation Makefile and README instructions
...
- moving Makefile to parent folder. This resolves some of the weird path/build issues
- remove trace references to cpydiff and original file (no longer used anywhere)
- converting SOURCEDIR to a changeable variable, passed through all sphinx-build calls
- adding path to conf.py, in case it moves again
- making `-v` default with VERBOSE
- making `-E` default with FORCE
- creating BASEOPTS to store all the dirs, paths, and settings, passing them to sphinx-build in one long chain, instead of individually
- updating README to use the make command as default. Also added text explaining some of the customization you can add into a make command
2018-05-14 11:02:25 -07:00
421b84af99
docs: Bump version to 1.9.4.
2018-05-11 16:39:59 +10:00
2955ada22f
docs: fix references to uhashlib
2018-05-06 12:31:54 -05:00
647ff387d9
docs: fix references to ubinascii
2018-05-03 09:34:43 -05:00
c7818032b1
docs/library: Add ussl module to library index for unix port.
2018-04-26 17:14:51 +10:00
c24b0a7f2b
docs/library/pyb.ADC: Fix typo of "prarmeter".
2018-04-20 15:54:09 +10:00
0600645944
docs/library/pyb.ADC: Remove outdated ADCAll code example.
2018-04-20 15:52:28 +10:00
b30e0d2f26
stm32/dac: Add buffering argument to constructor and init() method.
...
This can be used to select the output buffer behaviour of the DAC. The
default values are chosen to retain backwards compatibility with existing
behaviour.
Thanks to @peterhinch for the initial idea to add this feature.
2018-04-11 14:22:21 +10:00
aebd9701a7
stm32/adc: Optimise read_timed_multi() by caching buffer pointers.
2018-04-11 14:09:09 +10:00
4f40fa5cf4
stm32/adc: Add read_timed_multi() static method, with docs and tests.
2018-04-11 13:36:17 +10:00
8f11d0b532
docs/library/pyb.ADC.rst: Document new features for ADCAll.
2018-04-10 13:06:26 +10:00
f4563d11d1
Add four missing drivers
2018-03-27 14:25:14 -07:00
0abbafd424
stm32/can: Add "list" param to CAN.recv() to receive data inplace.
...
This API matches (as close as possible) how other pyb classes allow inplace
operations, such as pyb.SPI.recv(buf).
2018-03-19 15:12:24 +11:00
b7d576d69a
docs/library/pyb.CAN: Clean up documentation of data constants.
2018-03-16 18:29:43 +11:00
a25e6c6b65
stm32/can: Add CAN.info() method to retrieve error and tx/rx buf info.
2018-03-16 18:28:35 +11:00
d7e67fb1b4
stm32/can: Add CAN.state() method to get the state of the controller.
...
This is useful for monitoring errors on the bus and knowing when a restart
is needed.
2018-03-16 17:10:41 +11:00
1272c3c65d
stm32/can: Add CAN.restart() method so controller can leave bus-off.
2018-03-15 17:29:30 +11:00
823ca03008
stm32/can: Add "auto_restart" option to constructor and init() method.
2018-03-15 17:17:33 +11:00
d91a1989f5
docs/library/pyb.CAN: Update markup to use latest doc conventions.
2018-03-15 16:30:05 +11:00
0db49c37a4
docs: Fix some references and RST markup to eliminate Sphinx warnings.
2018-03-15 15:50:51 +11:00
4d3a92c67c
extmod/vfs_fat: Add file size as 4th element of uos.ilistdir tuple.
2018-03-12 12:26:36 +11:00
9cef2b03a7
docs/reference/repl.rst: Fix some minor errors in the REPL tutorial.
2018-03-09 16:14:58 +11:00
fa8f1a29e5
moved to top of list for alphabetical order
2018-03-07 23:10:25 -05:00
2de471950a
Added AM2320 to driver list
2018-03-07 17:25:43 -05:00
8359210e71
docs/library/uos: Document mount, umount, VfsFat and block devices.
2018-03-07 14:50:38 +11:00
63b003d523
docs/library/uos: Create sections for distinct parts and document uname.
2018-03-07 14:49:25 +11:00
402e71dcdd
Merge pull request #659 from tannewt/driver_page_update
...
Update driver links (for 3.x) including categories!
2018-03-06 21:41:47 -05:00
4f55205bf5
Fix links. Adding the en/latest/ circumvents a ReadTheDocs bug
...
which redirects projects incorrectly.
2018-03-06 18:24:56 -08:00
f16619ad3c
Update driver links including categories!
2018-03-06 16:54:13 -08:00
a5fb699d87
docs/library/micropython: Describe optimisation levels for opt_level().
2018-03-05 19:10:45 +11:00
6e09320b4c
docs/library/usocket: Make xref to uerrno explicitly a module reference.
2018-03-05 19:07:39 +11:00
ea633117d0
Remove bad c2rst and fix the other for sphinx 1.7.1
2018-02-27 18:08:49 -08:00
bf05183158
Merge remote-tracking branch 'adafruit/2.x' into merge_2x
2018-02-27 15:24:16 -08:00
c5fe610ba1
esp8266/modnetwork: Implement WLAN.status('rssi') for STA interface.
...
This will return the RSSI of the AP that the STA is connected to.
2018-02-26 16:41:13 +11:00
20dd3b1e43
Delete a bunch of docs, drivers and examples not relevant to CircuitPython.
...
This fixes #345 and fixes #215 .
2018-02-20 17:34:59 -08:00
e05fca4ef3
docs/library/ujson: Document dump() and load() functions.
2018-02-15 11:37:48 +11:00
9e8b7b1b63
docs/library/ujson: Update to conform with docs conventions.
...
The formatting of exception objects is done as per CPython conventions, eg:
:exc:`TypeError`
2018-02-15 11:31:34 +11:00
298b325f3e
docs/esp8266: Add a note concerning GPIO16 pull capabilities.
2018-02-15 11:15:12 +11:00
d072573226
docs/esp8266: Update PWM doc regarding clipping of min/max values.
2018-02-15 11:14:34 +11:00
2a3de8d185
Magnetometer values are also 3d vector of uT
...
Unless I have misunderstood something design guide should have matching the definition with [Unified Sensor Driver](https://github.com/adafruit/Adafruit_Sensor/blob/master/Adafruit_Sensor.h#L111 ).
2018-02-11 23:15:01 +07:00
09bf06bc6b
More formal
2018-02-08 22:19:00 -08:00
f0232c99c5
Changes based on feedback in #600 .
2018-02-08 12:48:59 -08:00
15db02664d
Clarify style of attribute comments in the Design Guide.
...
And update the core attributes to match the style.
2018-02-07 13:08:42 -08:00
e708e87139
docs/library/pyb.rst: Add note about availability of USB MSC-only mode.
2018-02-01 15:52:49 +11:00
d201ac20af
Fix sensor table. ( #517 )
...
RST is very picky about spacing.
2018-01-08 20:38:43 -05:00
5cb361cf1f
Merge pull request #510 from dhalbert/3.0_merge_2.2.0
...
merge from 2.2.0 + fix up board defs
2018-01-04 20:59:59 -05:00
7d3bec46ae
Changing magnetic attribute in design guide ( #502 )
2018-01-02 20:03:20 -08:00
065e82015f
merge from 2.2.0 + fix up board defs
2018-01-02 21:25:41 -05:00
5de064fbd0
docs/library/index: Elaborate uPy libraries intro.
2017-12-23 21:21:08 +02:00
Lucian Copeland
David Lechner
Jesse Andrews
adzierzanowski
Peter Hinch
sommersoft
Radomir Dopieralski
Jason Neal
Thorsten von Eicken
arturo182
Damien George
Matt Trentini
ketograph
Jim Mussared
Roy Hooper
Daniel Mizyrycki
Mike Wadsten
Volodymyr Shymanskyy
Mike Causer
Thiago Paes
Dan Halbert
Kamil Tomaszewski
sommersoft
Paul m. p. P
Vicki Lowe
Tom McDermott
Arsenijs
Alexander Hagerman
Craig Forbes
Nicko van Someren
John Reese
Yonatan Goldschmidt
Daniel O'Connor
Scott Shawcroft
spacemanspiff2007
brentru
Martin Fischer
johnthagen
Andrew Leech
Ayke van Laethem
stijn
Paul Sokolovsky
Dave Hylands
Nick Moore
Scott Shawcroft
jcea
Scott Shawcroft
bildzeitung
Karin Hawley
Jeff Epler
T S
Tom Collins
Kattni
Olivier Ortigues
Mika Tuupola
Dan Conley