a2391b5a74
Small WiPy doc fixes
8 years ago
3611dcc260
docs: Bump version to 1.8.4.
8 years ago
f3b5480be7
stmhal,cc3200,esp8266: Consistently use PWRON_RESET constant.
machine.POWER_ON is renamed to machine.PWRON_RESET to match other
reset-cause constants that all end in _RESET. The cc3200 port keeps a
legacy definition of POWER_ON for backwards compatibility.
8 years ago
dab0f316d2
docs/reference/isr_rules.rst: Two minor additions to docs for using ISR.
- Refers to the technique of instantiating an object for use in an ISR by
specifying it as a default argument.
- Footnote detailing the fact that interrupt handlers continue to be
executed at the REPL.
8 years ago
4a9542c0c0
docs/library/machine.WDT: Add that WDT is available on pyboard.
8 years ago
b4df3e74e1
docs/esp8266/quickref: Further improvements for SPI subsections.
Consistency and formatting.
8 years ago
20da9064d7
docs/esp8266/quickref: Update information on SPI classes.
SPI(1) is not used for hardware SPI. Few more details are provided.
8 years ago
76dcaddc0f
docs/esp8266/quickref: Add internal links to docs for some modules.
8 years ago
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
5c3a2f162e
docs/pyboard/quickref: Add links to pinouts for other pyboard variants.
8 years ago
0f8b1ba8a2
docs/library: Add reference for pyb.usb_mode and pyb.USB_HID.
8 years ago
f2da6467a9
docs/pyboard: Update USB mouse tutorial to use pyb.USB_HID().
8 years ago
57c92d90b0
docs/pyboard: Update USB mouse tutorial to use VCP instead of CDC.
8 years ago
13c5a228c9
docs/esp8266: Update quickref and tutorial for OneWire/DS18X20 driver.
8 years ago
ed0a06a93f
docs/esp8266/quickref: Fix and update the SPI docs
Use the `SPI` factory function in the examples, and use
proper baud rate of 80 000 000.
8 years ago
8e7dfea803
esp8266/modpybhspi: Add a HSPI module for hardware SPI support
This module uses ESP8266's SPI hardware, which allows much higher
speeds. It uses a library from
https://github.com/MetalPhreak/ESP8266_SPI_Driver
9 years ago
64c5a9435c
docs/library/machine.WDT: Add note that WDT is only available on WiPy.
8 years ago
5e01fb01b3
docs/esp8266/intro: Add command to install esptool.py 1.0.1 via pip.
It used a standard BootROM programming algo and may be useful as a
fallback.
8 years ago
2146cdab5e
docs/esp8266/tutorial/pins: Fix typo in commands for pin input mode.
8 years ago
e4e4526954
docs: Bump version to 1.8.3.
8 years ago
5c73de0337
docs/uio: Mention seek()/flush() support for io.BytesIO.
8 years ago
3e5534caf7
docs/esp8266/intro: Focus on hazards of unearthed power wrt electronics.
8 years ago
d2cab0b7be
docs/esp8266/tutorial/intro: Add anchor for link from quickeref.
8 years ago
f84dda7111
docs/esp8266/quickref: Link to installation instructions.
8 years ago
a9923d190e
docs/esp8266/intro: Add troubleshooting section.
Tries to summarize most of the issues we've seen so far.
8 years ago
919c54f750
docs/esp8266/intro: Rename to "Getting started" from "Introduction".
People tend to skip introductions (everyone knows what esp8266 is, right?),
so try to do A/B testing with a title inviting to read it.
8 years ago
1966745689
esp8266/tutorial/intro: Reword para abou -fm dio switch.
Not all NodeMCU boards require it.
8 years ago
fdb411a8c5
docs/library/index: Include array module in ToC.
8 years ago
8a0b6f561c
docs/array: Document array module.
8 years ago
ce166e6b68
docs: Spelling mistakes
8 years ago
b4564841b6
docs: Add DHT to ESP8266 Quick Ref and Tutorial
8 years ago
1459a8d5c9
docs: Bump version to 1.8.2.
8 years ago
047ac2044d
docs/library: Fix typo in docs for usocket.listen().
8 years ago
b2641b53e0
docs/conf.py: Exclude cmath from modindex for wipy.
9 years ago
2b6dcdd3e4
docs/sys: print_exception: Fixes/clarifications.
9 years ago
617e033e2f
docs/select: Add an article.
9 years ago
51805e4a3a
docs: Rebuild docs from scratch, as required for proper only:: handling.
Docs are now by default rebuilt from scratch, as required to build
conditionalized (i.e. using only:: directive) docs across different
output types. We have pretty small docset, so that's still rather fast.
However, if that's a concern, incremental rebuilds can be used by
passing "FORCE=" (nothing after =) as a make parameter. This will work
when using the same output type (e.g. only "html").
9 years ago
91031b60dc
docs/conf.py: Active sphinx_selective_exclude extensions.
For modindex_exclude extension, per-port module excludes are also added.
With these changes, it's possible to generate docs for a particular port
devoid of any superfluous and unrelated content, including in indexes and
full-text search - with small caveat: when generating PDF docs after HTML,
or vice-versa cached internal doctree representation (build/*/doctrees/)
must be removed first.
9 years ago
f6d01b8b67
docs: Add sphinx_selective_exclude extension suite.
Designed specifically to workaround issues we were facing with generating
multiple conditionalized output docsets from a single master doctree.
Extensions were factored out into a separate project, based on the fact
that many other Sphinx users experience similar or related problems:
https://github.com/pfalcon/sphinx_selective_exclude
Corresponds to the 182f4a8da57 upstream revision.
9 years ago
9de5eb278d
docs/sys: Detailed description of print_exception() diff from traceback module.
9 years ago
343b5c1081
docs/uctypes: Improve documentation.
Seealso and Limitations sectiosn added, better formatting and grammar.
9 years ago
79b40d1127
docs/machine*: Remove explicit targets and "machine." prefixes on classes.
With currentmodule:: set properly, none are needed. Extra "machine." prefix
produces wrong indexing data.
9 years ago
a0c296f6d5
docs/machine.Pin: Disambiguate object call method.
9 years ago
1d3b903eb5
docs/library/index: Add builtins.rst.
9 years ago
0cec4e9bb8
docs/builtins: Enumerate all builtin functions implemented.
Based on unix version. No descriptions so far.
9 years ago
f1eb672d88
docs/pyb.Pin: Sort .af() and .af_list() methods together.
9 years ago
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.
9 years ago
585aafc27e
docs/pyb.ExtInt,pyb.Pin: Mark up class methods as such.
9 years ago
0d8c22b122
docs/pyb.Pin: af_list() is a normal method, not a class method.
9 years ago
8171995ee9
docs/pyb.CAN: Mark CAN.initfilterbanks() as classmethod explicitly.
9 years ago
juhasch
Damien George
Peter Hinch
Paul Sokolovsky
Philip Potter
Radomir Dopieralski
Mike Causer
Martin Müller