20dd3b1e43
Delete a bunch of docs, drivers and examples not relevant to CircuitPython.
...
This fixes #345 and fixes #215 .
2018-02-20 17:34:59 -08: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
ea8be373a9
py/inlinethumb: Remove 30-bit restriction on movwt instruction.
...
movwt can now move a full 32-bit constant into a register.
2016-01-07 16:34:11 +00:00
521759ee18
docs: Add discussion on interrupt handlers incl uPy specific techniques.
2015-12-31 00:02:09 +00:00
3551368424
docs: Fix a typo in the REPL documentation.
2015-11-10 22:19:20 +02:00
b7ca945877
lib/mp-readline: Make it easy to exit auto-indent mode by pressing enter.
...
This patch allows you to stop auto-indent by pressing enter on a second
blank line. Easier than having to use backspace, and prevents new users
from getting stuck in auto-indent mode.
2015-11-07 13:07:43 +00:00
a9f3030371
docs: Add docs about REPL paste-mode and Control-C
2015-11-03 23:28:53 +00:00
0d3e309ebc
docs: Add link in references index to Thumb2 assembler docs.
2015-06-25 00:24:19 +01:00
2110dc5a6d
docs: Add reference for Thumb2 inline assembler.
...
Thanks to Peter Hinch for contributing this.
2015-06-25 00:21:35 +01:00
aef3846c13
docs: Add "reference" directory for putting docs about the language.
2015-06-25 00:20:57 +01:00
Scott Shawcroft
Paul Sokolovsky
Peter Hinch
Yuval Langer
Damien George
puuu
Mike Causer
Dave Hylands