Damien George
90c524c114
docs: Remove spaces on lines that are empty.
2019-12-04 15:02:54 +11:00
Damien George
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
cfcf47c064
in the initial development of the
cc3200 port, which had the pyb module before it switched to the machine
module. And wipy only conditionals were removed from the pyb module
documentation in 4542643025
, so there's no
need to retain any more conditionals.
2018-07-18 15:47:44 +10:00
Mike Causer
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
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
Damien George
0f87a010e3
docs: Update to say that Timer(3) is free, and detail LED intensity.
2016-01-29 23:06:13 +00:00
danicampora
4542643025
docs: Update all WiPy docs to reflect the new API.
2015-10-17 23:29:04 +02:00
Daniel Campora
ea2cc2b907
docs: Add more documentation for the CC3200 in the pyb module.
2015-06-16 15:45:24 +02:00
Ivan Pejić
e178ef2520
docs: Add additional example/note for Timer's callback usage.
...
Add example: using named function for the Timer's callback.
Add note: improving traceback inside interrupt timers.
2015-03-30 00:43:04 +01:00
Dave Hylands
b4c9a25eab
stmhal: Add support for quadrature encoder mode to pyb.TimerChannel.
2015-03-09 13:23:14 +00:00
Peter Hinch
b57b56f293
docs: Update pyb.Timer.rst to fix pulse widths that exceed the period.
2015-03-09 12:14:32 +00:00
Damien George
8e701604d5
docs: Add links from quickref to pyb classes.
2014-11-04 18:25:20 +00:00
Damien George
a58713a899
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
Damien George
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