summaryrefslogtreecommitdiffstatshomepage
path: root/docs
Commit message (Collapse)AuthorAge
* docs: Bump version to 1.9.2.v1.9.2Damien George2017-08-23
|
* docs: Consistently link to micropython-lib in glossary.Paul Sokolovsky2017-08-22
|
* docs/glossary: Fix typos in micropython-lib paragraph.Paul Sokolovsky2017-08-20
|
* docs/glossary: Elaborate on possible MicroPython port differences.Paul Sokolovsky2017-08-20
| | | | | | | 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.
* docs/library/usocket: Describe complete information on address formats.Paul Sokolovsky2017-08-20
| | | | | | Describe that the only portable way to deal with addresses is by using getaddrinfo(). Describe that some ports may support tuple addresses using "socket" module (vs "usocket" of native MicroPython).
* docs/library/usocket: Move socket.error to its own section.Paul Sokolovsky2017-08-20
| | | | It's too minor a point to start the module description with it.
* docs/library/ubinascii: Update base64 docs.Alex Robbins2017-08-17
| | | | | | | | | | | | | | | This clarifies return values and the handling of invalid (e.g. newline) characters. Encoding conforms to RFC 3548, but decoding does not, as it ignores invalid characters in base64 input. Instead, it conforms to MIME handling of base64 (RFC 2045). Note that CPython doesn't document handling of invalid characters in a2b_base64() docs: https://docs.python.org/3/library/binascii.html#binascii.a2b_base64 , so we specify it more explicitly than it, based on CPython's actual behavior (with which MicroPython now compliant).
* docs/library/machine.RTC.rst: Fix typo.Javier Candeira2017-08-14
|
* docs/esp8266/tutorial: Fix typo, "its" to "it's" in powerctrl.rst.Matthew Brener2017-07-24
|
* eps8266/general: Fix typo in recent example.Paul Sokolovsky2017-07-21
|
* eps8266/general: Add known issue of WiFi RX buffers overflow.Peter Hinch2017-07-21
|
* docs/pyboard/tutorial/amp_skin: Add example for playing large WAV files.Piotr Maliński2017-07-21
|
* docs,teensy: Use the name MicroPython consistently in documentationAlexander Steffen2017-07-15
|
* docs/uzlib: Update description of decompress() and mention DecompIO.Paul Sokolovsky2017-07-04
|
* docs/pyboard: Move info about using Windows from topindex to general.Damien George2017-07-03
|
* docs/esp8266/general.rst: Fix name of NTP module.Patrick O'Leary2017-07-02
| | | The simple NTP client module is named "ntptime.py".
* docs/uerrno: Document "uerrno" module.Paul Sokolovsky2017-07-03
|
* docs/pyboard: Move hardware info into General Info chapter.Paul Sokolovsky2017-07-02
| | | | | | | | This makes top-level ToC of the pyboard docs consistent with other ports (consisting of 3 chapters: QuickRef, General Info, and Tutorial). Also, some other minor tweaks applied, like local ToC for General Info and headings mentioning pyboard.
* docs/*_index: Drop "Indices and tables" pseudo-section.Paul Sokolovsky2017-07-02
| | | | | | This pseudo-section causes artifacts with latexpdf generation (almost empty page with list containing literal "genindex", "modeindex", "search" items). For HTML docs, these sections can be accessed from "home" page.
* docs/conf.py: Set "version" and "release" to the same value.Paul Sokolovsky2017-07-02
| | | | | | We don't use alpha/beta/RC, so for us version and release should be the same, or it leads to confusion (for example, current, 1.9.1 docs are marked as 1.9 at places).
* docs/replace.inc: Add |see_cpython|, to xref individual symbols from CPython.Paul Sokolovsky2017-07-02
| | | | The idea is to use it for each symbol in builtins.rst.
* docs/library: Add CPython docs xref to each pertinent module.Paul Sokolovsky2017-07-02
| | | | | Cross-reference text/link is implemented as RST substitution, so easy to consistently.
* docs/conf.py: Add file for global replacements definition.Paul Sokolovsky2017-07-02
| | | | | | | The idea is to allow to define a kind of "macros" for repeatitive text, so all occurrances can be updated in one place. Unfortunately, RST doesn't support replacements with arguments, which limits usefulness of them and should be taken into account.
* docs/conf.py: Switch to "new" format of intersphinx_mapping.Paul Sokolovsky2017-07-02
| | | | | | | As described at http://www.sphinx-doc.org/en/stable/ext/intersphinx.html#confval-intersphinx_mapping This will allow to explicitly refer to CPython docs for cross-references.
* docs/topindex.html: Fix typo in "Glossary" heading.Damien George2017-07-02
|
* docs: Add glossary.Paul Sokolovsky2017-07-02
| | | | | | 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.
* docs/ure: Elaborate doc, update markup to the latest conventions.Paul Sokolovsky2017-07-02
|
* docs/builtins: Add AssertionError, SyntaxError, ZeroDivisionError.Paul Sokolovsky2017-07-01
| | | | Also, update heading of 1st sections to "Functions and types".
* reference/index: Rewrite introduction paragraph to avoid confusion.Paul Sokolovsky2017-07-01
| | | | | | | | | | | 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".
* docs/differences/index_template: Use consistent heading casing.Paul Sokolovsky2017-07-01
| | | | | And in our case, "consistent" is where each word in the heading is *not* capitalized.
* docs: Move topindex.html to templates/ subdir.Damien George2017-07-01
| | | | | Later versions of jinja2 need it to be in this subdir, and earlier versions work with it here as well.
* docs/conf.py: Add .venv dir to exclude_patterns.Paul Sokolovsky2017-07-01
| | | | | It's useful to try different Sphinx versions using virtualenv/venv, so exclude a common venv dir name from Sphinx processing.
* docs/constrained: Use markup adhering to the latest docs conventions.Paul Sokolovsky2017-07-01
|
* docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions.Paul Sokolovsky2017-06-30
|
* docs/topindex.html: Remove link to wipy.io, it's no longer available.Damien George2017-06-30
|
* docs/{framebuf,usocket}: Use markup adhering to the latest docs conventions.Paul Sokolovsky2017-06-29
|
* docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions.Paul Sokolovsky2017-06-28
|
* docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions.Paul Sokolovsky2017-06-27
|
* docs: Move all ports docs to the single ToC.Paul Sokolovsky2017-06-27
| | | | | | | | | | | | | | Previously, only "selected chapters" were shown in left-pane ToC (of Read The Docs theme). These chapters were selected out of order. The rest of chapters were hidden beyond "Documentation Contents" pseudo- chapter. This arguably led only to confusion, as many people probably never tried to open that pseudo-chapter, and those who did, were confused. Such organization is even worse for PDF output, causing chapters go in mix-mashed order. So, instead move to single clean ToC. This will allow readers of HTML to have access to any doc content at their fingertips (and straight before their eyes), and will allow to finally have clean PDF docs.
* docs/library/gc: Fix grammar and improve readability of gc.threshold().Damien George2017-06-26
|
* docs/esp8266/tutorial/intro: Fix some grammatical typos.Damien George2017-06-26
|
* docs/ref/speed_python: Update and make more hardware-neutral.Paul Sokolovsky2017-06-26
| | | | | | | | 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.
* docs/network: Use markup adhering to the latest docs conventions.Paul Sokolovsky2017-06-26
|
* docs/machine*: Use markup adhering to the latest docs conventions.Paul Sokolovsky2017-06-25
|
* docs/lcd160cr: Group related constants together. Use full sentences.Paul Sokolovsky2017-06-25
| | | | Per the latest docs conventions.
* docs/conf.py: Set default_role = 'any'.Paul Sokolovsky2017-06-25
| | | | | | | | | | | | | | | | This causes `symbol` syntax to be equivalent to :any:`symbol`, which is in turn the easiest way to cross-reference an arbitrary symbol in the docs: http://www.sphinx-doc.org/en/stable/markup/inline.html#role-any :any: requires at least Sphinx 1.3 (for reference, Ubuntu 16.03 ships with 1.3.6, the latest 1.6.3). Any many of our docs, `symbol` is misused to specify arguments to functions, etc. Refactoring that is in progress. (CODECONVENTIONS already specify proper syntax for both arguments and xrefs, based on CPython conventions).
* docs/utime: Use markup adhering to the latest conventions.Paul Sokolovsky2017-06-25
|
* docs/lcd160cr: Use markup adhering to the latest conventions.Paul Sokolovsky2017-06-25
|
* docs/btree: Use markup adhering to the latest conventions.Paul Sokolovsky2017-06-25
|
* docs/builtins: List builtin exceptions.Paul Sokolovsky2017-06-24
| | | | If for nothing else, then at least to cross-reference them.
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-30 05:51:58 +0000