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
bba77a2d01
docs/machine.Pin: Add class designator to all constants.
This makes rendered docs to not provide incorrect information and
consistent with how it's down for other machine classes.
9 years ago
7d7243f44c
docs/machine.*: 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
93968bd6fb
docs/machine.UART: Cleanup pyboard section.
9 years ago
0a4361ca67
docs/machine.Pin: Remove explicit target.
With currentmodule:: support, all targets should be generated properly by
Sphinx.
9 years ago
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.
9 years ago
c8b7628094
docs/machine.*: Add "currentmodule:: machine" directive.
Makes sure that classes described in these separate files are properly
designated as belonging to "machine" module in indexes.
9 years ago
2c5fc681c8
docs/library/machine.Pin: Mention GPIO and cross-link .value() function.
9 years ago
6e2fa5237d
docs/usocket: There must be empty line after .only:: .
9 years ago
9b18811951
docs/ure: Typo fix.
9 years ago
753a965363
docs/esp.socket: Remove unused file.
9 years ago
9487b80666
docs/library/network: wipy: Fix literal block indentation.
9 years ago
2bf6eb9fe2
docs: Add link to PDF version of docs in sidebar.
Requires a link of the form: <BASEURL>/<lang>/<ver>/micropython-<port>.pdf
9 years ago
0b913bd09f
docs/esp8266/tutorial/network_basics: Minor typo fix, ap becomes ap_if.
9 years ago
9b39263b11
docs: Bump version to 1.8.1.
9 years ago
3f6ca4b22c
docs/esp8266/general: Add note about RTC overflow.
9 years ago
d8cc51ea2b
docs/esp8266/quickref: Update WebREPL section for 1.8.1 release.
WebREPL is much more stable now.
9 years ago
ed4e5d2583
docs/library/index: Fix grammar and spelling in intro paragraph.
9 years ago
0b9725812e
docs/wipy/tutorial: Add note about screen key bindings on OS X.
9 years ago
e456b2cc94
docs/README: Add some hints for PDF docs generation.
9 years ago
09f764dc04
docs/library/index: Add intro paragraph regarding availability of modules.
This introductions makes explicit the fact that whenever possible,
the documentation describes full MicroPython functionality, and arbitrary
functions/classes/modules may be missing in a paricular port or build.
9 years ago
9a1a49ceec
esp8266/general: Typo/grammar fixes.
9 years ago
fdf45a718b
esp8266/quickref: Use local image of Adafruit Huzzah board.
Using remote image causes problems with tools (partly because the image
is semi-firewalled and can't be accessed by arbitrary tools).
9 years ago
c4ab8895e8
docs: math, cmath: Add port availability information.
9 years ago
1a05a59116
docs/math: Typo fix.
9 years ago
93a9c2e840
docs/library/machine: Add documentation for machine.time_pulse_us.
9 years ago
641300dccb
stmhal/dac: DAC deinit() method added.
9 years ago
7d4fd8b6db
docs/esp8266/general: Remove duplicate phrase.
9 years ago
a3dc2c6031
docs/machine: Make disable_irq and enable_irq docs available for all.
9 years ago
eaecc4c02e
docs/esp8266/general: Grammar fixes.
9 years ago
3e33aeb0db
docs: esp8266: Include ussl module in the docs.
9 years ago
bca4c9e465
docs/ussl: Add basic description of axTLS-based modussl.
In particular, disclose the fact that server certificates are not
validated.
9 years ago
a0a08b4be1
esp8266: Add APA102 serial individually controllable LEDs support.
APA102 is a new "smart LED", similar to WS2812 aka "Neopixel".
9 years ago
Martin Müller
Paul Sokolovsky
Damien George
Ben Hagen
puuu
Marcel Stör
Peter Hinch
Tomas R
mad474
misterdanb