aec88ddf03
docs: More consistent capitalization and use of articles in headings.
...
See issue #3188 .
2020-01-06 22:17:29 +11:00
e58c7ce3d6
docs/reference: Add documentation describing use of .mpy files.
...
Including information about .mpy versioning and how to debug failed imports
of .mpy files.
2019-12-19 17:06:27 +11:00
b310930dba
docs/library/uos: Add notes and links about littlefs failures.
2019-12-10 16:58:53 +11:00
381be9a745
docs/reference/filesystem: Add note and example about using filesystem.
2019-12-09 14:21:22 +11:00
50dc5f10a6
docs/reference/filesystem: Fix typo in block device code example.
2019-12-09 14:13:09 +11:00
9a849cc7ca
docs: Add littlefs docs and a filesystem tutorial.
2019-12-04 23:18:23 +11:00
d7dbd267e7
docs/reference: Add docs describing use of pyboard.py.
2019-12-04 23:18:03 +11:00
90c524c114
docs: Remove spaces on lines that are empty.
2019-12-04 15:02:54 +11:00
a2c4cb484d
docs: Fix spelling in various parts of the docs.
2019-10-16 14:08:28 +11:00
a93495b66d
docs/reference/glossary.rst: Add new terms and reduce complexity of old.
2019-10-15 16:36:02 +11:00
afc8596c15
docs/reference/speed_python: Add missing self to var caching example.
2019-08-28 12:55:41 +10:00
3a679eaf00
docs/reference/speed_python: Update that read-only buffers are accepted.
...
As allowed by recent cd35dd9d9a
2019-08-19 16:39:30 +10:00
89ff506513
py: Update and rework build system for including external C modules.
...
How to use this feature is documented in docs/develop/cmodules.rst.
2019-03-08 22:58:42 +11:00
2e516074da
py: Implement a module system for external, user C modules.
...
This system makes it a lot easier to include external libraries as static,
native modules in MicroPython. Simply pass USER_C_MODULES (like
FROZEN_MPY_DIR) as a make parameter.
2019-03-08 22:49:00 +11:00
812969d615
all: Change PYB message prefix to MPY.
...
Replaces "PYB: soft reboot" with "MPY: soft reboot", etc.
Having a consistent prefix across ports reduces the difference between
ports, which is a general goal. And this change won't break pyboard.py
because that tool only looks for "soft reboot".
2019-02-12 15:18:33 +11:00
0ab8428995
docs/reference/index: Remove conditional for inline asm docs.
...
The heading of this section makes it clear it is for Thumb-2 architectures
only.
2018-07-20 15:51:06 +10:00
0db49c37a4
docs: Fix some references and RST markup to eliminate Sphinx warnings.
2018-03-15 15:50:51 +11:00
9cef2b03a7
docs/reference/repl.rst: Fix some minor errors in the REPL tutorial.
2018-03-09 16:14:58 +11:00
e37ccfe59b
docs/packages: Explicitly recommend usage of setuptools instead of distutils.
2017-12-16 10:42:30 +02:00
9251f1395e
docs/packages: Use "install_dir/" in examples.
2017-12-16 10:37:36 +02:00
448d93a04a
docs/glossary: micropython-lib: Clarify wording.
2017-12-15 00:11:02 +02:00
bf73ee114f
docs/packages: mpy_bin2res no longer required to create resources.
...
Everything happens automagically with overridden "sdist" from
sdist_upip.py.
2017-12-14 18:28:10 +02:00
54cd6e3e4b
docs/packages: Add quick "Creating distribution packages" section.
...
Needs more details.
2017-12-13 00:12:37 +02:00
c60fc670ea
docs/reference/packages: Add chapter on distribution packages and deployment.
...
A long overdue overview of preparing packages, installing them with upip,
freezing, dealing with resources. Initial version, more iterations required.
2017-12-11 00:08:41 +02:00
ca8034d6b8
docs/glossary: Clarify wording for "baremetal".
2017-12-06 00:08:24 +02:00
155ec21e49
docs/glossary: Describe string interning.
2017-12-04 01:01:03 +02:00
8175f1608e
docs/glossary: Describe "stream" term.
2017-12-03 18:56:18 +02:00
4fee35a32c
docs/glossary: Describe the callee-owned tuple concept.
2017-12-03 15:08:39 +02:00
ec1e9a10a7
docs: Add notes on heap allocation caused by bound method refs.
2017-11-23 11:35:58 +11:00
05a2bb888f
docs/reference/isr_rules: Minor typo correction.
2017-10-30 13:29:00 +11:00
da1c80d850
docs/reference/isr_rules.rst Add tutorial on use of micropython.schedule().
2017-09-09 16:05:24 +03:00
4a93801c12
all: Update Makefiles and others to build with new ports/ dir layout.
...
Also renames "stmhal" to "stm32" in documentation and everywhere else.
2017-09-06 14:09:13 +10:00
358a7ba014
docs: More xrefs to "MicroPython port" in glossary.
2017-08-28 13:51:05 +03:00
387a8d26f9
docs/glossary: Fix typos in micropython-lib paragraph.
2017-08-20 10:44:02 +03:00
46583e9057
docs/glossary: Elaborate on possible MicroPython port differences.
...
State that this doc describes generic, "core" MicroPython functionality,
any particular port may diverge in both directions, by both omitting
some functionality, and adding more, both cases described outside the
generic documentation.
2017-08-20 10:11:44 +03:00
d0797fbc18
docs: Add glossary.
...
We have enough terms or references throughout the docs which may be not
immediately clear or have some important nuances. Referencing terms in
gloassary is the best way to deal with that.
2017-07-02 13:47:35 +03:00
8b7d311595
reference/index: Rewrite introduction paragraph to avoid confusion.
...
The old intro talked about "differences", but there were hardly any
sections describing differences, mostly MicroPython specific features.
On the other hand, we now have real "differences" chapter, though it's
mostly concerned with stdlib differences.
So, try to avoid confusion by changing wording and linking to the other
chapters and contrasting them with what is described in "MicroPython
language".
2017-07-01 22:09:40 +03:00
e334b6b6d2
docs/constrained: Use markup adhering to the latest docs conventions.
2017-07-01 19:28:55 +03:00
a926119099
docs/ref/speed_python: Update and make more hardware-neutral.
...
Move hardware-specific optimizations to the very end of document, and
add visible note that it gives an example for Pyboard. Remove references
to specific hardware technologies, so the doc can be more naturally
used across ports. Various markup updates to adhere to the latest
docs conventions.
2017-06-26 01:11:17 +03:00
933198c55f
docs/*/quickref.rst: Use new semantics of ticks_diff()
2016-11-08 02:01:05 +03: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
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
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +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
47f9b10b30
docs/speed_python: Generalize "Floating point" subsection.
...
Don't describe just single port's peculiarities, note aboute possible
array of issues with floating-point.
2016-04-15 17:43:03 +03:00
6c84f1e03a
docs/speed_python: Clarify/generalize "Buffers" subsection.
2016-04-15 17:24:56 +03:00
21b74604f9
docs: Add Python speed optimisation guide, including minimal viper ref.
2016-03-11 16:33:36 +00:00
70f32f0f73
docs: Update asm_thumb2_hints_tips re return type of asm funcs.
2016-03-11 16:32:42 +00:00
c13b2f2d00
docs: Several minor changes: network, pyb, ADCAll and inline asm.
2016-01-13 21:53:26 +00:00
Jason Neal
Damien George
Daniel Mizyrycki
Jim Mussared
Mike Causer
Paul m. p. P
Peter Hinch
Andrew Leech
Ayke van Laethem
Paul Sokolovsky
Yuval Langer
puuu