summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2017-04-09docs/library/builtins: int: Add notice on byteorder param for to/from_bytes.Paul Sokolovsky
2017-04-07docs/esp8266/general: Start explicit "Known Issues", mentioned RTC inaccuracy.Paul Sokolovsky
2017-04-05docs/machine.Pin: Move wipy-specific methods to its docs.Paul Sokolovsky
2017-04-05docs/machine.Pin: Move wipy-specific details to its own docs.Paul Sokolovsky
2017-04-05cc3200/modmachine: Return frequency value directly, like other ports.Paul Sokolovsky
2017-04-05docs/machine.SPI: Remove outdated wipy chunk.Paul Sokolovsky
2017-04-05docs/uos: De-conditionalize statvfs() description.Paul Sokolovsky
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-05docs/utime: De-conditionalize description of sleep_ms() and friends.Paul Sokolovsky
These are basic MicroPython API, and all ports should implement them.
2017-04-04extmod/modframebuf: Make monochrome bitmap formats start with MONO_.Peter Hinch
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-04docs/library/btree: Add btree module docs.Paul Sokolovsky
2017-03-20docs/library/machine.I2C: Fix scan() doc to match implementation.transistortim
Since eaef6b5324fa2ff425802d4abeea45aa945bfc14 writes are used instead of reads.
2017-03-17utime module documentation fixes and cleanup:Christopher Arndt
* 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-15docs/library/framebuf: Fix typo in bit-width for MVLSB description.Damien George
2017-03-07docs/esp8266/tutorial: Update since esptool 1.3 added Python 3 support.James Ouyang
esptool 1.3 now supports both Python 2.7 and 3.4+. Updated github link to now-official espressif repo.
2017-03-07docs/library/lcd160cr: Add link to framebuf page.Rami Ali
2017-03-07docs/library: Add framebuf documentation.Rami Ali
2017-02-28docs/library/lcd160cr: Add note about supported JPEG format/encodings.Peter Hinch
2017-02-28docs/machine: Fix formatting of Constants section.Paul Sokolovsky
Render related constants grouped together, with common description.
2017-02-27docs/Makefile: define and use PYTHON as the interpreter for CPYDIFFKrzysztof Blazewicz
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-26docs/uhashlib: Provide port-neutral description.Paul Sokolovsky
TODO: Remove WiPy-specific chunks.
2017-02-20docs: Modify Makefile and indexes to generate cPy-differences pages.Rami Ali
2017-02-20tools: Add gen-cpydiff.py to generate docs differences.Rami Ali
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-17docs/library/lcd160cr: Mention the valid values for set_power() method.Damien George
2017-02-14docs/uos: Remove mention of uos.sep.Paul Sokolovsky
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-13docs/library/machine: Make separate TOC for WiPy vs non-WiPy.Damien George
WiPy is the only port with ADC and SD, so they shouldn't be included in other ports' documentation.
2017-02-13docs/library/pyb.Pin: Minor typo fix, B6 should be A0.Dave Hylands
On the PYBv1.0, X1 maps to A0, not B6.
2017-02-07docs: Add M-logo as favicon.Damien George
2017-02-07docs/esp8266/tutorial: Specify the baudrate in picocom example command.Damien George
2017-02-07stmhal: Add ability to skip booting from SD card via /flash/SKIPSD file.Damien George
2017-02-06stmhal: Add pyb.fault_debug() function, to control hard-fault behaviour.Damien George
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-05extmod/machine_pulse: Make time_pulse_us() not throw exceptions.Paul Sokolovsky
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-03docs: For LCD160CR driver and tutorial, add link to positioning image.Damien George
2017-01-30docs/pyboard/tutorial/lcd160cr_skin: Fix typo, get_touched->get_touch.Damien George
2017-01-29docs/uio: Typo fixes/lexical improvements.Paul Sokolovsky
2017-01-29docs/conf.py: Add myself as a copyright holder on the docs.Paul Sokolovsky
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-28docs/uio: Describe differences between uPy an CPy stream hierarchy.Paul Sokolovsky
2017-01-28docs/usocket: Dedent Methods section.Paul Sokolovsky
This was apparently of an ::only directive which was later removed.
2017-01-28docs/usocket: Clarify description of various methods.Paul Sokolovsky
2017-01-28docs/usocket: Elaborate "Constants" section.Paul Sokolovsky
2017-01-28docs/usocket: Clarify exceptions used.Paul Sokolovsky
2017-01-28docs/machine: Add explicit note on machine module level and scope.Paul Sokolovsky
It's very low, hardware level, with associated constraints on operations and callbacks.
2017-01-28docs/machine.Timer: Move WiPy adhoc parts to its documentation.Paul Sokolovsky
2017-01-24docs/library/lcd160cr: Fix set_brightness range, should be 0..31.Damien George
2017-01-23docs/pyboard/tutorial: Add tutorial for LCD160CR.Damien George
2017-01-23docs: Add documentation for lcd160cr module.Damien George
2017-01-18docs: Fix some minor spelling mistakes.Mike Causer
paramter -> parameter send a receive -> send and receive repsonse -> response particualr -> particular constructore -> constructor
2017-01-08docs: Bump version to 1.8.7.v1.8.7Damien George
2017-01-07docs/usocket: Clarify that socket timeout raises OSError exception.Paul Sokolovsky
2017-01-06docs/library/esp: Remove para and add further warning about flash.Damien George
There is no longer space reserved by default for native code.
2017-01-04docs/library/esp: Document esp.set_native_code_location() function.Damien George