e76c7466b6
docs: Change `\*` to `*` in argument lists.
...
Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and
will render the `\` in the output if it is there, so remove it.
Fixes issue #6209 .
2020-08-21 12:24:13 +10:00
90c524c114
docs: Remove spaces on lines that are empty.
2019-12-04 15:02:54 +11:00
78e0e76b4f
docs/library/pyb.USB_VCP.rst: Add info about id and flow params.
2019-09-26 14:00:21 +10:00
3ff7040c8a
docs/library: Add xrefs to "stream" dictionary entry for many modules.
2017-12-04 18:36:20 +02:00
b1457db002
docs/library: Add missing cross-ref links for classes in pyb module.
2017-10-11 11:30:16 +11:00
a392b3aa75
docs: Remove references to readall() and update stream read() docs.
2016-11-14 23:31:40 +11:00
a384a53130
docs/pyb.*: Use proper class case in method headers.
...
Class designator will be used as is in indexes, so must match actual class
name.
2016-06-08 16:21:28 +03:00
0a4cc24b2e
docs/pyb.*: Add "currentmodule:: pyb" directive.
...
Makes sure that classes described in these separate files are properly
designated as belonging to "pyb" module in indexes.
2016-06-08 00:57:41 +03:00
b7ab70c71c
docs: USB_VCP: Always in non-blocking mode, clarify stream method returns.
...
They return None if no data available.
2015-10-25 13:24:29 +03:00
0bfc57022d
docs: Document USB_VCP file-like methods.
2015-05-13 20:42:12 +01:00
d39c7aa517
stmhal: Add Python-configurable USB HID mode.
...
Different HID modes can be configured in Python. You can either use
predefined mouse or keyboard, or write your own report descriptor.
2015-02-13 14:02:51 +00:00
19fb1b4dd7
stmhal: Add USB_VCP.setinterrupt method, to disable CTRL-C.
2014-11-29 15:23:21 +00:00
a58713a899
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
88d3054ac0
docs: Import documentation from source-code inline comments.
...
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Zenix27
Damien George
Paul Sokolovsky
Mike Causer