ae831ec0a8
docs/library/micropython: Deconditionalize.
2017-04-16 09:18:47 +03:00
a1c39ffb69
docs/esp8266/tutorial/intro: Reword section on flash size requirement.
...
Give a clearly dissuading tone on end users trying 512KB version
- it has to many end-usery features lacking.
2017-04-14 01:12:04 +03:00
b87432b8fb
docs/uhashlib: Deconditionalize.
...
Notes on WiPy incompatibilities with the standard module API are
moved under "Known issues" to its documentation.
2017-04-09 00:57:54 +03:00
2e58474580
docs/usocket: Deconditionalize.
...
Notes on WiPy incompatibilities with the standard socket module API are
moved under "Known issues" to its documentation.
2017-04-09 00:48:28 +03:00
3acace588a
docs/utime: Deconditionalize description of sleep().
2017-04-09 00:42:32 +03:00
1d74559b6b
docs/library/machine.UART: Remove some conditionals.
2017-04-09 00:25:27 +03:00
bcf3c8bf17
docs/library/builtins: int: Add notice on byteorder param for to/from_bytes.
2017-04-09 00:06:54 +03:00
e5278b98fe
docs/esp8266/general: Start explicit "Known Issues", mentioned RTC inaccuracy.
2017-04-07 10:52:50 +03:00
390d5a3bf1
docs/machine.Pin: Move wipy-specific methods to its docs.
2017-04-05 13:05:04 +03:00
d46899626e
docs/machine.Pin: Move wipy-specific details to its own docs.
2017-04-05 12:09:36 +03:00
9a38b7afe0
cc3200/modmachine: Return frequency value directly, like other ports.
2017-04-05 11:58:17 +03:00
4333b2fb53
docs/machine.SPI: Remove outdated wipy chunk.
2017-04-05 11:47:15 +03:00
906d58f6f2
docs/uos: De-conditionalize statvfs() description.
...
It's a standard function, and it's already described (in the library
intro) that for any given port, any function may be missing.
2017-04-05 11:44:10 +03:00
0a861db91c
docs/utime: De-conditionalize description of sleep_ms() and friends.
...
These are basic MicroPython API, and all ports should implement them.
2017-04-05 11:40:47 +03:00
468c6f9da1
extmod/modframebuf: Make monochrome bitmap formats start with MONO_.
...
MONO_xxx is much easier to read if you're not familiar with the code.
MVLSB is deprecated but kept for backwards compatibility, for the time
being.
This patch also updates the associated docs and tests.
2017-04-04 17:38:33 +10:00
bb296482c3
docs/library/btree: Add btree module docs.
2017-04-04 00:29:23 +03:00
fb981107eb
docs/library/machine.I2C: Fix scan() doc to match implementation.
...
Since eaef6b5324
2017-03-20 15:30:41 +11:00
9b80a1e3e9
utime module documentation fixes and cleanup:
...
* Fix mis-spelling of `ticks_add` in code examples.
* Be consistent about parentheses after function names.
* Be consistent about formatting of function, variable and constant names.
* Be consistent about spaces and punctuation.
* Fix some language errors (missing or wrong words, wrong word order).
* Keep line length under 90 chars.
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
2017-03-17 20:45:08 +03:00
fcab435607
docs/library/framebuf: Fix typo in bit-width for MVLSB description.
2017-03-15 21:54:56 +11:00
e73a0b944f
docs/esp8266/tutorial: Update since esptool 1.3 added Python 3 support.
...
esptool 1.3 now supports both Python 2.7 and 3.4+.
Updated github link to now-official espressif repo.
2017-03-07 18:23:24 +11:00
2646b9e022
docs/library/lcd160cr: Add link to framebuf page.
2017-03-07 18:17:40 +11:00
f9d18d96b7
docs/library: Add framebuf documentation.
2017-03-07 18:16:46 +11:00
1f549a3496
docs/library/lcd160cr: Add note about supported JPEG format/encodings.
2017-02-28 17:45:24 +11:00
ed81574fe9
docs/machine: Fix formatting of Constants section.
...
Render related constants grouped together, with common description.
2017-02-28 00:38:15 +03:00
ae116c2430
docs/Makefile: define and use PYTHON as the interpreter for CPYDIFF
...
User can override PYTHON executable before running script,
gen-cpydiff.py works only with Python3 and most systems register
its executable as 'python3'.
2017-02-27 15:39:55 +11:00
e2f1a8a7ee
docs/uhashlib: Provide port-neutral description.
...
TODO: Remove WiPy-specific chunks.
2017-02-26 00:55:33 +03:00
3218ccd70d
docs: Modify Makefile and indexes to generate cPy-differences pages.
2017-02-20 17:14:35 +11:00
b7fa63c7ce
tools: Add gen-cpydiff.py to generate docs differences.
...
This patch introduces the a small framework to track differences between
uPy and CPython. The framework consists of:
- A set of "tests" which test for an individual feature that differs between
uPy and CPy. Each test is like a normal uPy test in the test suite, but
has a special comment at the start with some meta-data: a category (eg
syntax, core language), a human-readable description of the difference, a
cause, and a workaround. Following the meta-data there is a short code
snippet which demonstrates the difference. See tests/cpydiff directory
for the initial set of tests.
- A program (this patch) which runs all the tests (on uPy and CPy) and
generates nicely-formated .rst documenting the differences.
- Integration into the docs build so that everything is automatic, and the
differences appear in a way that is easy for users to read/reference (see
latter commits).
The idea with using this new framework is:
- When a new difference is found it's easy to write a short test for it,
along with a description, and add it to the existing ones. It's also easy
for contributors to submit tests for differences they find.
- When something is no longer different the tool will give an error and
difference can be removed (or promoted to a proper feature test).
2017-02-20 17:14:34 +11:00
d80df91ef2
docs/library/lcd160cr: Mention the valid values for set_power() method.
2017-02-17 16:57:22 +11:00
ee3615d800
docs/uos: Remove mention of uos.sep.
...
MicroPython guarantees '/' to be a path separator, so extra constant taking
precious ROM space are not needed. MicroPython never had such constant, only
one vendor port had it (now unmaintained).
2017-02-14 13:14:46 +03:00
0c821f7def
docs/library/machine: Make separate TOC for WiPy vs non-WiPy.
...
WiPy is the only port with ADC and SD, so they shouldn't be included in
other ports' documentation.
2017-02-13 13:06:51 +11:00
2f76c3ca0a
docs/library/pyb.Pin: Minor typo fix, B6 should be A0.
...
On the PYBv1.0, X1 maps to A0, not B6.
2017-02-13 11:52:44 +11:00
21f08524ba
docs: Add M-logo as favicon.
2017-02-07 20:04:40 +11:00
3217bbe491
docs/esp8266/tutorial: Specify the baudrate in picocom example command.
2017-02-07 16:58:43 +11:00
9779c99317
stmhal: Add ability to skip booting from SD card via /flash/SKIPSD file.
2017-02-07 12:35:39 +11:00
27c149efe0
stmhal: Add pyb.fault_debug() function, to control hard-fault behaviour.
...
This new function controls what happens on a hard-fault:
- debugging disabled: board will do a reset
- debugging enabled: board will print registers and stack and flash LEDs
The default is disabled, ie to do a reset. This is different to previous
behaviour which flashed the LEDs and waited indefinitely.
2017-02-06 13:22:17 +11:00
d5e9ab6e61
extmod/machine_pulse: Make time_pulse_us() not throw exceptions.
...
machine.time_pulse_us() is intended to provide very fine timing, including
while working with signal bursts, where each transition is tracked in row.
Throwing and handling an exception may take too much time and "signal loss".
So instead, in case of a timeout, just return negative value. Cases of
timeout while waiting for initial signal stabilization, and during actual
timing, are recognized.
The documentation is updated accordingly, and rewritten somewhat to clarify
the function behavior.
2017-02-05 14:20:17 +03:00
50a9dd59f5
docs: For LCD160CR driver and tutorial, add link to positioning image.
2017-02-03 12:48:54 +11:00
5ec5bfb0d3
docs/pyboard/tutorial/lcd160cr_skin: Fix typo, get_touched->get_touch.
2017-01-30 18:19:29 +11:00
0ddeedfc73
docs/uio: Typo fixes/lexical improvements.
2017-01-29 16:18:33 +03:00
bdb0d22fe2
docs/conf.py: Add myself as a copyright holder on the docs.
...
Based on the following statistics:
$ git log docs |grep Author | sort | uniq -c | sort -n -r
175 Author: Paul Sokolovsky
135 Author: Damien George
31 Author: Daniel Campora
26 Author: danicampora
14 Author: Peter Hinch
git blame stats script from http://stackoverflow.com/a/13687302/496009 :
$ sh git-authors docs
9977 author Damien George
2679 author Paul Sokolovsky
1699 author Daniel Campora
1580 author danicampora
1286 author Peter Hinch
282 author Shuning Bian
249 author Dave Hylands
Total lines per this script: 18417, my contribution is 14.5%.
2017-01-29 16:12:07 +03:00
ef6fb66d23
docs/uio: Describe differences between uPy an CPy stream hierarchy.
2017-01-28 16:35:40 +03:00
6947a7f6a9
docs/usocket: Dedent Methods section.
...
This was apparently of an ::only directive which was later removed.
2017-01-28 15:49:54 +03:00
f23c47fea7
docs/usocket: Clarify description of various methods.
2017-01-28 15:39:18 +03:00
74fcb122f0
docs/usocket: Elaborate "Constants" section.
2017-01-28 14:46:58 +03:00
59540dccf1
docs/usocket: Clarify exceptions used.
2017-01-28 13:55:51 +03:00
0aa83142a4
docs/machine: Add explicit note on machine module level and scope.
...
It's very low, hardware level, with associated constraints on operations
and callbacks.
2017-01-28 12:08:25 +03:00
56e7ebf07a
docs/machine.Timer: Move WiPy adhoc parts to its documentation.
2017-01-28 12:08:00 +03:00
c707668d9e
docs/library/lcd160cr: Fix set_brightness range, should be 0..31.
2017-01-24 00:17:39 +11:00
7d08bc27e2
docs/pyboard/tutorial: Add tutorial for LCD160CR.
2017-01-23 15:50:37 +11:00
e72e343908
docs: Add documentation for lcd160cr module.
2017-01-23 14:37:10 +11:00
a79f6676c3
docs: Fix some minor spelling mistakes.
...
paramter -> parameter
send a receive -> send and receive
repsonse -> response
particualr -> particular
constructore -> constructor
2017-01-18 15:30:31 +11:00
5653e3c72f
docs: Bump version to 1.8.7.
2017-01-08 23:53:08 +11:00
a1a8f01799
docs/usocket: Clarify that socket timeout raises OSError exception.
2017-01-07 14:23:33 +03:00
36ec5c8f27
docs/library/esp: Remove para and add further warning about flash.
...
There is no longer space reserved by default for native code.
2017-01-06 18:32:49 +11:00
c3f70c603e
docs/library/esp: Document esp.set_native_code_location() function.
2017-01-04 23:48:19 +11:00
52c19875a4
esp8266/general: Add "Scarcity of runtime resources" section.
...
With warnings of need to close files, sockets, etc.
2017-01-04 10:33:48 +03:00
e1f495a4bd
docs/esp8266/tutorial: Close socket after reading page content.
2017-01-04 11:15:02 +11:00
d377c83794
docs/library/machine.I2C: Fix I2C constructor docs to match impl.
2016-12-30 15:25:48 +11:00
71ff0b549d
docs/esp8266/tutorial: Update intro to add Getting the firmware section.
...
Add a "Getting the firmware" section to better describe how to get hold of
the MicroPython firmware, especially if you have a 512kb module.
2016-12-30 14:27:02 +11:00
a5b3c7e7f9
docs/library/pyb.UART: Moved writechar doc to sit with other writes.
2016-12-15 09:59:45 +11:00
0caac94b98
docs/library/pyb.UART: Added clarification about timeouts.
2016-12-15 09:59:32 +11:00
46e59c52af
docs/library/pyb.Accel: Add hardware note about pins used by accel.
2016-12-02 17:39:13 +11:00
63a5df3cb4
docs/library/machine.I2C: Refine definitions of I2C methods.
2016-11-23 17:05:02 +11:00
64db4080ce
docs/library/index: Elaborate on u-modules.
...
Also, remove an "only" directive in u-modules description.
2016-11-16 01:18:19 +03:00
a392b3aa75
docs: Remove references to readall() and update stream read() docs.
2016-11-14 23:31:40 +11:00
c4e58eaa98
stmhal/i2c: Add option to I2C to enable/disable use of DMA transfers.
...
New keyword option in constructor and init() method is "dma=<bool>".
DMA is now disabled by default for I2C transfers because it currently does
not handle I2C bus errors very well (eg if slave device doesn't ACK or
NACK correctly during a transfer).
2016-11-11 17:36:19 +11:00
5a1d63fc14
docs: Bump version to 1.8.6.
2016-11-10 21:24:53 +11:00
3e5e4f95b2
docs/library/machine.Pin: Update Pin docs to align with new HW API.
2016-11-09 11:08:01 +11:00
5630778f0f
esp8266: Update docs for esptool 1.2.1/SDK 2.0 (--flash_size=detect).
2016-11-08 04:52:07 +03:00
933198c55f
docs/*/quickref.rst: Use new semantics of ticks_diff()
2016-11-08 02:01:05 +03:00
5c3d75c937
docs/esp8266: Update for new WebREPL setup procedure.
2016-11-06 10:02:33 +03:00
805f7ea2f2
docs/utime: Add docs for ticks_add(), improvements for other ticks_*().
2016-11-01 00:14:12 +03:00
8679d9e6a6
docs/utime: Remove only:: for ticks_diff().
...
It's mandatory function which should be present in every port. Even if
it's not, in the stdlib intro we waarn users that a particular port can
lack anything of described in the docs.
2016-11-01 00:03:40 +03:00
d60ad5cf53
docs/utime: Describe new semantics of ticks_diff() (signed ring arithmetics).
2016-10-31 00:17:56 +03:00
153665f159
docs/utime: Document ticks_cpu() in more detail.
...
Also, drop ::only directive.
2016-10-30 23:15:28 +03:00
7219a18d17
docs/library/index: Update TOCs so builtins sorted before modules.
2016-10-30 23:13:52 +03:00
c28f9df63a
docs/library/network: Typo fixes, consistent acronym capitalization.
2016-10-28 12:03:35 +03:00
b9a88683a4
docs/library/network: Reword intro paragraph.
2016-10-28 04:42:27 +03:00
67c91df7e8
docs/machine.SPI.rst: Fix typos and formatting, clarify.
...
Clarify the class implements master side of the protocol, also put adhoc
WiPy paramter after the generic, described in the current Hardware API
version.
2016-10-25 17:03:35 +03:00
f1b2b1b600
docs/library/builtins: Add docs for delattr and slice.
2016-10-25 11:02:47 +11:00
266e4acdc2
docs/library/machine.SPI: Remove spurious "of".
2016-10-24 14:41:21 +11:00
f12047f66d
docs/machine.SPI: Improve descriptions of xfer methods.
...
In particular remove the "*" because not all ports support keyword
arguments.
2016-10-18 10:14:26 +11:00
a0b2f48c2f
docs/machine.SPI: Bring up to date with Hardware API, make vendor-neutral.
2016-10-17 18:05:16 +03:00
c8d31585a0
docs: Bump version to 1.8.5.
2016-10-17 15:32:43 +11:00
9e1dec1818
docs/reference: Add constrained.rst doc.
...
It contains detailed information about writing scripts to run efficiently
on microcontrollers (and other constrained systems).
2016-10-11 15:27:20 +11:00
a181340ad8
docs/wipy: Correct deep sleep current figure.
2016-10-10 14:22:39 +02:00
00c1fc6d77
docs/uos: Add uos.statvfs() documentation.
2016-10-07 13:16:54 +11:00
eb239b8398
stmhal/usb: Add support to receive USB HID messages from host.
2016-10-04 15:38:01 +11:00
219245e10f
extmod/machine_i2c: Add support for the addrsize parameter in mem xfers.
...
The memory read/write I2C functions now take an optional keyword-only
parameter that specifies the number of bits in the memory address.
Only mem-addrs that are a multiple of 8-bits are supported (otherwise
the behaviour is undefined).
Due to the integer type used for the address, for values larger than 32
bits, only 32 bits of address will be sent, and the rest will be padded
with 0s. Right now no exception is raised when that happens. For values
smaller than 8, no address is sent. Also no exception then.
Tested with a VL6180 sensor, which has 16-bit register addresses.
Due to code refactoring, this patch reduces stmhal and esp8266 builds
by about 50 bytes.
2016-09-28 14:45:29 +10:00
eeb9d99333
docs/library/machine: Update description of disable/enable IRQ funcs.
2016-09-23 13:15:58 +10:00
4ab3eef8d7
docs/library/pyb.SPI: init(): Describe "bits" argument.
...
Based on https://github.com/micropython/micropython/pull/2210 .
2016-09-18 21:41:21 +03:00
a2391b5a74
Small WiPy doc fixes
2016-09-18 21:38:29 +03:00
3611dcc260
docs: Bump version to 1.8.4.
2016-09-09 14:07:09 +10:00
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.
2016-09-08 12:50:38 +10:00
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.
2016-09-07 17:12:42 +10:00
4a9542c0c0
docs/library/machine.WDT: Add that WDT is available on pyboard.
2016-09-06 14:20:52 +10:00
b4df3e74e1
docs/esp8266/quickref: Further improvements for SPI subsections.
...
Consistency and formatting.
2016-09-04 23:31:05 +03:00
20da9064d7
docs/esp8266/quickref: Update information on SPI classes.
...
SPI(1) is not used for hardware SPI. Few more details are provided.
2016-09-04 21:13:55 +03:00
76dcaddc0f
docs/esp8266/quickref: Add internal links to docs for some modules.
2016-08-29 17:40:36 +10:00
efc904c41d
docs/pyboard/quickref: Add section on "delay and timing" for utime mod.
...
And remove reference to deprecated pyb.delay() and pyb.millis().
2016-08-29 17:33:02 +10:00
5c3a2f162e
docs/pyboard/quickref: Add links to pinouts for other pyboard variants.
2016-08-29 17:32:38 +10:00
0f8b1ba8a2
docs/library: Add reference for pyb.usb_mode and pyb.USB_HID.
2016-08-29 15:17:20 +10:00
f2da6467a9
docs/pyboard: Update USB mouse tutorial to use pyb.USB_HID().
2016-08-29 15:16:51 +10:00
57c92d90b0
docs/pyboard: Update USB mouse tutorial to use VCP instead of CDC.
2016-08-29 15:15:25 +10:00
13c5a228c9
docs/esp8266: Update quickref and tutorial for OneWire/DS18X20 driver.
2016-08-29 12:52:50 +10:00
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.
2016-08-28 23:14:45 +10:00
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
2016-08-19 21:19:59 +03:00
64c5a9435c
docs/library/machine.WDT: Add note that WDT is only available on WiPy.
2016-08-17 14:22:39 +10:00
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.
2016-08-10 21:40:40 +03:00
2146cdab5e
docs/esp8266/tutorial/pins: Fix typo in commands for pin input mode.
2016-08-09 21:13:27 +03:00
e4e4526954
docs: Bump version to 1.8.3.
2016-08-09 23:49:25 +10:00
5c73de0337
docs/uio: Mention seek()/flush() support for io.BytesIO.
2016-08-09 01:52:56 +03:00
3e5534caf7
docs/esp8266/intro: Focus on hazards of unearthed power wrt electronics.
2016-08-07 22:41:34 +03:00
d2cab0b7be
docs/esp8266/tutorial/intro: Add anchor for link from quickeref.
2016-08-07 22:16:40 +03:00
f84dda7111
docs/esp8266/quickref: Link to installation instructions.
2016-08-07 17:46:27 +03:00
a9923d190e
docs/esp8266/intro: Add troubleshooting section.
...
Tries to summarize most of the issues we've seen so far.
2016-08-07 17:28:33 +03:00
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.
2016-08-07 17:28:23 +03:00
1966745689
esp8266/tutorial/intro: Reword para abou -fm dio switch.
...
Not all NodeMCU boards require it.
2016-08-07 16:31:09 +03:00
fdb411a8c5
docs/library/index: Include array module in ToC.
2016-08-07 00:16:41 +03:00
8a0b6f561c
docs/array: Document array module.
2016-08-07 00:13:48 +03:00
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +03:00
b4564841b6
docs: Add DHT to ESP8266 Quick Ref and Tutorial
2016-08-01 14:39:57 +03:00
1459a8d5c9
docs: Bump version to 1.8.2.
2016-07-10 12:46:50 +01:00
047ac2044d
docs/library: Fix typo in docs for usocket.listen().
2016-06-26 12:38:20 +01:00
b2641b53e0
docs/conf.py: Exclude cmath from modindex for wipy.
2016-06-19 19:17:42 +03:00
2b6dcdd3e4
docs/sys: print_exception: Fixes/clarifications.
2016-06-18 19:06:53 +03:00
617e033e2f
docs/select: Add an article.
2016-06-18 19:06:42 +03:00
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").
2016-06-14 00:23:33 +03:00
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.
2016-06-12 01:18:13 +03:00
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.
2016-06-12 01:13:39 +03:00
9de5eb278d
docs/sys: Detailed description of print_exception() diff from traceback module.
2016-06-10 23:06:56 +03:00
343b5c1081
docs/uctypes: Improve documentation.
...
Seealso and Limitations sectiosn added, better formatting and grammar.
2016-06-09 05:02:55 +03:00
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.
2016-06-09 03:03:53 +03:00
a0c296f6d5
docs/machine.Pin: Disambiguate object call method.
2016-06-09 02:58:15 +03:00
1d3b903eb5
docs/library/index: Add builtins.rst.
2016-06-09 00:26:44 +03:00
0cec4e9bb8
docs/builtins: Enumerate all builtin functions implemented.
...
Based on unix version. No descriptions so far.
2016-06-09 00:24:52 +03:00
f1eb672d88
docs/pyb.Pin: Sort .af() and .af_list() methods together.
2016-06-08 16:36:22 +03: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
585aafc27e
docs/pyb.ExtInt,pyb.Pin: Mark up class methods as such.
2016-06-08 16:00:12 +03:00
0d8c22b122
docs/pyb.Pin: af_list() is a normal method, not a class method.
2016-06-08 15:57:46 +03:00
8171995ee9
docs/pyb.CAN: Mark CAN.initfilterbanks() as classmethod explicitly.
2016-06-08 15:49:30 +03:00
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.
2016-06-08 01:37:03 +03:00
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.
2016-06-08 01:33:49 +03:00
93968bd6fb
docs/machine.UART: Cleanup pyboard section.
2016-06-08 01:32:16 +03:00
0a4361ca67
docs/machine.Pin: Remove explicit target.
...
With currentmodule:: support, all targets should be generated properly by
Sphinx.
2016-06-08 01:13:59 +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
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.
2016-06-08 00:46:27 +03:00
2c5fc681c8
docs/library/machine.Pin: Mention GPIO and cross-link .value() function.
2016-06-07 17:49:00 +03:00
6e2fa5237d
docs/usocket: There must be empty line after .only:: .
2016-06-07 17:41:21 +03:00
9b18811951
docs/ure: Typo fix.
2016-06-07 08:53:54 +03:00
753a965363
docs/esp.socket: Remove unused file.
2016-06-07 02:40:05 +03:00
9487b80666
docs/library/network: wipy: Fix literal block indentation.
2016-06-07 02:07:08 +03:00
2bf6eb9fe2
docs: Add link to PDF version of docs in sidebar.
...
Requires a link of the form: <BASEURL>/<lang>/<ver>/micropython-<port>.pdf
2016-06-06 11:37:40 +01:00
0b913bd09f
docs/esp8266/tutorial/network_basics: Minor typo fix, ap becomes ap_if.
2016-06-06 10:08:30 +01:00
9b39263b11
docs: Bump version to 1.8.1.
2016-06-03 15:45:43 +01:00
3f6ca4b22c
docs/esp8266/general: Add note about RTC overflow.
2016-06-03 14:37:49 +01:00
d8cc51ea2b
docs/esp8266/quickref: Update WebREPL section for 1.8.1 release.
...
WebREPL is much more stable now.
2016-06-02 20:11:40 +03:00
ed4e5d2583
docs/library/index: Fix grammar and spelling in intro paragraph.
2016-06-02 11:05:13 +01:00
0b9725812e
docs/wipy/tutorial: Add note about screen key bindings on OS X.
2016-06-02 00:13:21 +03:00
e456b2cc94
docs/README: Add some hints for PDF docs generation.
2016-06-02 00:08:47 +03:00
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.
2016-06-02 00:08:07 +03:00
9a1a49ceec
esp8266/general: Typo/grammar fixes.
2016-06-01 23:16:17 +03:00
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).
2016-06-01 23:11:49 +03:00
c4ab8895e8
docs: math, cmath: Add port availability information.
2016-06-01 22:12:39 +03:00
1a05a59116
docs/math: Typo fix.
2016-06-01 22:09:51 +03:00
93a9c2e840
docs/library/machine: Add documentation for machine.time_pulse_us.
2016-05-31 14:06:33 +01:00
641300dccb
stmhal/dac: DAC deinit() method added.
2016-05-31 13:10:35 +03:00
7d4fd8b6db
docs/esp8266/general: Remove duplicate phrase.
2016-05-30 19:20:11 +03:00
a3dc2c6031
docs/machine: Make disable_irq and enable_irq docs available for all.
2016-05-26 15:47:47 +01:00
eaecc4c02e
docs/esp8266/general: Grammar fixes.
2016-05-23 23:33:23 +03:00
3e33aeb0db
docs: esp8266: Include ussl module in the docs.
2016-05-22 23:57:26 +03:00
bca4c9e465
docs/ussl: Add basic description of axTLS-based modussl.
...
In particular, disclose the fact that server certificates are not
validated.
2016-05-22 23:56:22 +03:00
a0a08b4be1
esp8266: Add APA102 serial individually controllable LEDs support.
...
APA102 is a new "smart LED", similar to WS2812 aka "Neopixel".
2016-05-19 22:29:11 +03:00
ca63c77073
docs/ustruct: Describe supported type codes.
2016-05-14 20:48:43 +03:00
ccb00b7724
docs/esp8266/quickstart: remove i2c examples with stop=False
...
Since the ``stop`` parameter has been dropped.
2016-05-14 00:02:02 +02:00
9b4502b7e8
docs/esp8266/tutorial: Fix typo in do_connect() network example.
...
Fixes issue #2065 .
2016-05-11 13:40:28 +01:00
e89413e9b0
docs/esp8266/quickref: New way to get MAC address
2016-05-10 00:31:57 +02:00
c156e89379
Fix ESP8266 Network tutorial
...
The socket should either connect to `addr` or `addr_info[0][-1]`. Not to `addr[0][-1]`.
2016-05-07 23:24:24 -07:00
0c86a9471a
docs/machine.UART: Filter out unimplemented UART methods from esp8266 docs.
2016-05-07 20:20:04 +03:00
2c2fc070ec
docs: Bump version to 1.8.
2016-05-03 17:32:32 +01:00
56fd33a6dd
docs/esp8266/tutorial: Change name of ESP8266 firmware to match actual.
2016-05-03 16:42:52 +01:00
c68c327310
docs/esp8266/tutorial/repl: Reword description of initial WebREPL setup a bit.
2016-05-03 18:40:16 +03:00
1f396c58d9
docs/esp8266/tutorial/repl: Suggest using hosted WebREPL client.
...
At http://micropython.org/webrepl .
2016-05-03 18:35:43 +03:00
5d05993f10
esp8266/tutorial: Mention that esptool is available via pip.
2016-05-03 14:05:50 +01:00
8af64bcf2b
docs/esp8266/tutorial: Update pins tutorial to reflect changes in API.
2016-05-03 13:56:15 +01:00
5036b6ad18
docs/library/machine.Pin: Update pin docs to reflect ESP8266 support.
2016-05-03 13:55:37 +01:00
81a99eb388
docs/machine: idle() description generalization.
2016-05-03 12:53:57 +03:00
bb6458bf43
docs/machine: More generic description of sleep's, WiPy details to its genref.
2016-05-03 12:48:20 +03:00
db99ae00a2
docs/machine: Move WiPy-specific hardware details to its general reference.
2016-05-03 12:26:55 +03:00
06ec96b47b
docs/machine: Generalize docs from just WiPy to other ports.
2016-05-03 12:15:29 +03:00
879bc4197a
docs/esp8266: Add ESP8266 tutorial.
2016-05-03 01:39:04 +01:00
a6cf45864f
docs/network: esp8266: MAC address is set via .config() method.
2016-05-03 01:04:40 +03:00
ae845f13de
docs: Use getaddrinfo() result in easy way.
...
Instead of extracting 4th element, extact last. Much easier to remember!
2016-05-03 00:48:04 +03:00
5302c3e8c4
docs/esp8266_contents: Referebce general and tutorial docs.
2016-05-02 17:45:42 +03:00
a22aa53ef1
docs/esp8266/general: Add "Boot process" section.
2016-05-02 17:41:08 +03:00
12144e8fcd
docs/esp8266/general: Add techspec section.
...
Link to vendor forum with datasheets, etc. is provided, as well as inline
TTX.
2016-05-02 17:12:25 +03:00
0f682f1ee1
docs/esp8266/general: Fix list formatting.
2016-05-02 16:10:48 +03:00
5aa4db0505
docs/esp8266/general: Add more points to "Multitude of boards" section.
2016-05-02 16:00:44 +03:00
74c6363b97
docs/esp8266/general: WebREPL is described in quickref for now.
2016-05-02 15:26:40 +03:00
c816b89353
docs/library/machine.I2C: Update to reflect ESP8266 implementation.
...
This machine.I2C documentation is now closer to a more port-neutral
description, although there are still differences between WiPy and
ESP8266.
2016-05-02 12:31:17 +01:00
621c644205
docs: _io and _collections were renamed to have standard "u" prefix.
2016-05-02 14:02:54 +03:00
70ff7350e7
stmhal, cc3200: Change i2c.scan() method to scan addresses 0x08-0x77.
...
A standard I2C address is 7 bits but addresses 0b0000xxx and 0b1111xxx
are reserved. The scan() method is changed to reflect this, along with
the docs.
2016-05-02 11:15:36 +01:00
8ebdbcfb27
docs: Add _io module reference.
2016-05-02 00:39:36 +03:00
348caaf940
docs: Add _collections module reference.
2016-05-02 00:36:58 +03:00
fd283eba64
docs/sys: Describe sys.platform is port-neutral manner.
2016-05-01 14:39:38 +03:00
e9b7610748
docs/sys: Describe sys.maxsize.
2016-05-01 14:31:08 +03:00
59603a2e89
docs/sys: Describe sys.implementation.
2016-05-01 13:59:34 +03:00
4fb9452bff
docs/sys: Clean up print_exception() description.
2016-05-01 13:44:06 +03:00
ad2889c141
docs/sys: Clarify description of sys.exit().
2016-05-01 13:42:36 +03:00
8ad1659f68
docs/sys: Make module variable descriptions proper sentences.
2016-05-01 13:38:45 +03:00
7781caf8d3
docs/sys: Remove port-specific details from description of stdin/out/err.
2016-05-01 13:37:28 +03:00
c468fe65c5
docs/ustruct: Fix argument formatting.
...
Per current CPython docs conventions, arguments are in italics. Follow
that.
2016-05-01 13:34:16 +03:00
a9ed42b3b4
docs/sys: Document sys.modules.
2016-05-01 13:32:15 +03:00
6b6acc5b5d
docs/ustruct: Document pack_into(), unpack_from().
2016-05-01 13:17:07 +03:00
d46cd02d95
docs/esp8266/quickref: Add info about WebREPL.
2016-05-01 11:41:46 +03:00
83e99f88cb
docs/utime: Clarify module purpose.
2016-05-01 01:48:30 +03:00
613fd0a1ca
docs/library/utime: Elaborate on epochs and calendar time maintenance.
2016-05-01 00:16:47 +03:00
348edad888
docs/esp8266: Update quickref to reflect changes to 1-wire and NeoPixel.
2016-04-28 14:31:37 +01:00
37d5aa1377
docs: Make the short port names in the port/version sidebar lowercase.
...
To make it neater and simpler.
2016-04-28 12:34:59 +01:00
6d8156ae28
docs/network: esp8266: Describe wlan.config() method.
2016-04-28 00:11:55 +03:00
06deec9d35
docs/network: esp8266: Add wlan.ifconfig() method.
2016-04-28 00:10:29 +03:00
1b45670c69
docs/ubinascii: Clean up grammar.
2016-04-27 15:47:33 +03:00
df4e1d1279
docs/library: Consistently use admonitions for CPython differences.
2016-04-27 15:43:48 +03:00
31300b5144
docs/utime: Describe sleep() peculiarities in MicroPython.
...
Not all ports accept floating-point value.
2016-04-27 15:28:46 +03:00
c564169c8f
docs/utime: Describe time() peculiarities in MicroPython.
2016-04-27 15:23:11 +03:00
556e5dfd35
docs/library/utime: Add more time functions for unix and esp8266 ports.
2016-04-27 12:30:59 +01:00
e0f7e001e8
docs: Fix uos and utime heading underlines to be the correct length.
...
Otherwise Sphinx gives a warning.
2016-04-27 12:11:27 +01:00
351ec6d4ab
docs/library: "os" module is actually "uos".
2016-04-27 01:55:06 +03:00
f3f5e975e4
docs/Makefile: Default BUILDDIR based on MICROPY_PORT.
...
It doesn't make sense to duplicate both on command line, and MICROPY_PORT
is effectively mandatory to build docs.
2016-04-27 01:50:05 +03:00
0df2ee0126
docs/library/index: Order sections from the most to least standard modules.
2016-04-27 01:38:59 +03:00
492bf12499
docs/library/index: Make single section for "micro-ified" modules.
...
Even the modules whose names don't start with "u" prefix are micro-ified
anyway, i.e. provide only subset of CPython's functionality (and sometimes
extensions to it). So, it doesn't make much sense to devide them by
criteria of having/not having "u" prefix.
2016-04-27 01:38:59 +03:00
678f3a1e05
docs: Module "time" is actually "utime".
2016-04-27 01:38:59 +03:00
a119983328
docs/library/index: esp8266 has the same set of stdlibs as pyboard/unix.
2016-04-27 01:17:28 +03:00
88ed518390
docs/library/index: Move WiPy "micro-libraries" under corresponding heading.
2016-04-27 01:14:16 +03:00
8b8c32c09b
docs/library: Group MicroPython-specific modules under separate heading.
2016-04-27 01:11:24 +03:00
650df97c06
docs/network: esp8266: scan(): Add note that bssid is bytes object.
2016-04-26 01:09:11 +03:00
0d10e5310a
docs/usocket: Describe address format once at the beginning.
...
Different ports may have different formats.
2016-04-23 00:31:05 +03:00
92497bff94
docs/usocket: socket.IPPROTO_SEC is WiPy-specific.
2016-04-23 00:17:34 +03:00
955b8526f4
docs/usocket: Socket-specific exceptions are for WiPy only.
2016-04-23 00:17:09 +03:00
71c6f93016
docs/library/usocket: Add link to CPython's socket module.
2016-04-23 00:08:43 +03:00
bbe5245028
docs: esp8266: Include usocket module reference.
2016-04-23 00:08:11 +03:00
3bc9b571bb
docs/ustruct: There's no complete "struct" module, only "ustruct" subset.
...
"ustruct" is good example of micro-ified module, so rather should belong
to the corresponding list.
2016-04-22 22:37:14 +03:00
5c8147528e
docs/esp8266/tutorial: Add tutorial placeholder page.
2016-04-22 22:37:02 +03:00
fcc9d43c6d
docs/esp8266: Add info about using deep-sleep mode to quickref.
2016-04-21 12:01:50 +01:00
2a51f72ed1
docs/esp8266/general: Start "General information" for esp8266.
2016-04-21 01:03:51 +03:00
f73d78394b
docs/topindex.html: esp8266: Enable quickref/general on the main page.
2016-04-21 01:03:27 +03:00
67ece47121
docs/machine: reset_cause() has been implemented for esp8266.
2016-04-17 17:40:08 +03:00
53ac7830cb
docs/speed_python: Add article.
2016-04-15 20:09:59 +03:00
5801967496
docs/speed_python: Add many more details on memoryviews.
2016-04-15 18:18:18 +03:00
Paul Sokolovsky
Peter Hinch
transistortim
Christopher Arndt
Damien George
James Ouyang
Rami Ali
Krzysztof Blazewicz
Dave Hylands
Mike Causer
Max
Andrew Mulholland
Lorenz Schmid
puuu
daniel
Alex March
Philip Potter
Radomir Dopieralski
juhasch
Martin Müller
Ben Hagen
Marcel Stör
Tomas R
mad474
misterdanb
Paulus Schoutsen