aec88ddf03
docs: More consistent capitalization and use of articles in headings.
See issue #3188 .
5 years ago
e58c7ce3d6
docs/reference: Add documentation describing use of .mpy files.
Including information about .mpy versioning and how to debug failed imports
of .mpy files.
5 years ago
b310930dba
docs/library/uos: Add notes and links about littlefs failures.
5 years ago
381be9a745
docs/reference/filesystem: Add note and example about using filesystem.
5 years ago
50dc5f10a6
docs/reference/filesystem: Fix typo in block device code example.
5 years ago
9a849cc7ca
docs: Add littlefs docs and a filesystem tutorial.
5 years ago
d7dbd267e7
docs/reference: Add docs describing use of pyboard.py.
5 years ago
90c524c114
docs: Remove spaces on lines that are empty.
5 years ago
a2c4cb484d
docs: Fix spelling in various parts of the docs.
6 years ago
a93495b66d
docs/reference/glossary.rst: Add new terms and reduce complexity of old.
5 years ago
afc8596c15
docs/reference/speed_python: Add missing self to var caching example.
5 years ago
3a679eaf00
docs/reference/speed_python: Update that read-only buffers are accepted.
As allowed by recent cd35dd9d9a
5 years ago
89ff506513
py: Update and rework build system for including external C modules.
How to use this feature is documented in docs/develop/cmodules.rst.
6 years ago
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.
6 years ago
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".
7 years ago
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.
6 years ago
0db49c37a4
docs: Fix some references and RST markup to eliminate Sphinx warnings.
7 years ago
9cef2b03a7
docs/reference/repl.rst: Fix some minor errors in the REPL tutorial.
7 years ago
e37ccfe59b
docs/packages: Explicitly recommend usage of setuptools instead of distutils.
7 years ago
9251f1395e
docs/packages: Use "install_dir/" in examples.
7 years ago
448d93a04a
docs/glossary: micropython-lib: Clarify wording.
7 years ago
bf73ee114f
docs/packages: mpy_bin2res no longer required to create resources.
Everything happens automagically with overridden "sdist" from
sdist_upip.py.
7 years ago
54cd6e3e4b
docs/packages: Add quick "Creating distribution packages" section.
Needs more details.
7 years ago
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.
7 years ago
ca8034d6b8
docs/glossary: Clarify wording for "baremetal".
7 years ago
155ec21e49
docs/glossary: Describe string interning.
7 years ago
8175f1608e
docs/glossary: Describe "stream" term.
7 years ago
4fee35a32c
docs/glossary: Describe the callee-owned tuple concept.
7 years ago
ec1e9a10a7
docs: Add notes on heap allocation caused by bound method refs.
7 years ago
05a2bb888f
docs/reference/isr_rules: Minor typo correction.
7 years ago
da1c80d850
docs/reference/isr_rules.rst Add tutorial on use of micropython.schedule().
7 years ago
4a93801c12
all: Update Makefiles and others to build with new ports/ dir layout.
Also renames "stmhal" to "stm32" in documentation and everywhere else.
7 years ago
358a7ba014
docs: More xrefs to "MicroPython port" in glossary.
7 years ago
387a8d26f9
docs/glossary: Fix typos in micropython-lib paragraph.
7 years ago
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.
7 years ago
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.
7 years ago
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".
7 years ago
e334b6b6d2
docs/constrained: Use markup adhering to the latest docs conventions.
7 years ago
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.
7 years ago
933198c55f
docs/*/quickref.rst: Use new semantics of ticks_diff()
8 years ago
9e1dec1818
docs/reference: Add constrained.rst doc.
It contains detailed information about writing scripts to run efficiently
on microcontrollers (and other constrained systems).
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
ce166e6b68
docs: Spelling mistakes
8 years ago
53ac7830cb
docs/speed_python: Add article.
9 years ago
5801967496
docs/speed_python: Add many more details on memoryviews.
9 years ago
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.
9 years ago
6c84f1e03a
docs/speed_python: Clarify/generalize "Buffers" subsection.
9 years ago
21b74604f9
docs: Add Python speed optimisation guide, including minimal viper ref.
9 years ago
70f32f0f73
docs: Update asm_thumb2_hints_tips re return type of asm funcs.
9 years ago
c13b2f2d00
docs: Several minor changes: network, pyb, ADCAll and inline asm.
9 years ago
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