summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2018-03-06Fix links. Adding the en/latest/ circumvents a ReadTheDocs bugScott Shawcroft
which redirects projects incorrectly.
2018-03-06Update driver links including categories!Scott Shawcroft
2018-02-20Delete a bunch of docs, drivers and examples not relevant to CircuitPython.Scott Shawcroft
This fixes #345 and fixes #215.
2018-02-11Magnetometer values are also 3d vector of uTMika Tuupola
Unless I have misunderstood something design guide should have matching the definition with [Unified Sensor Driver](https://github.com/adafruit/Adafruit_Sensor/blob/master/Adafruit_Sensor.h#L111).
2017-11-14Update info about erasing CIRCUITPY to include flash erasers for non-… (#427)Dan Halbert
Update info about erasing CIRCUITPY to include flash erasers for non-Express boards.
2017-09-07updated the http reference for max7219 to use the readthedocs from the ↵2.0.0stablemrmcwethy
adafruit cirtcuitpython area instead of the micropython area
2017-09-06Added DotStar to line 722.0.0-rc.2KurticusMaximus
2017-09-05Add a micropython section and edit drivers docCarol Willing
2017-09-01Style tweaks based on @willingc's feedback.2.0.0-rc.1Scott Shawcroft
2017-09-01docs: Add beginnings of troubleshooting doc.Scott Shawcroft
Fixes #172. Related to #214.
2017-08-25Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in ↵Dan Halbert
development) master. cpx build compiles and loads and works in repl; test suite not run yet esp8266 not tested yet
2017-08-23docs: Bump version to 1.9.2.v1.9.2Damien George
2017-08-22docs: Consistently link to micropython-lib in glossary.Paul Sokolovsky
2017-08-20docs/glossary: Fix typos in micropython-lib paragraph.Paul Sokolovsky
2017-08-20docs/glossary: Elaborate on possible MicroPython port differences.Paul Sokolovsky
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-20docs/library/usocket: Describe complete information on address formats.Paul Sokolovsky
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).
2017-08-20docs/library/usocket: Move socket.error to its own section.Paul Sokolovsky
It's too minor a point to start the module description with it.
2017-08-17docs/library/ubinascii: Update base64 docs.Alex Robbins
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).
2017-08-16Update docs README to mention requirement for recommonmark dependency.Tony DiCola
2017-08-14docs/library/machine.RTC.rst: Fix typo.Javier Candeira
2017-08-07docs: Add link to SD card driver.Scott Shawcroft
2017-07-28Update favicon to blinka.Scott Shawcroft
2017-07-28docs: Add links to NeoPixel and SimpleIO docs.Scott Shawcroft
2017-07-24docs/esp8266/tutorial: Fix typo, "its" to "it's" in powerctrl.rst.Matthew Brener
2017-07-21eps8266/general: Fix typo in recent example.Paul Sokolovsky
2017-07-21eps8266/general: Add known issue of WiFi RX buffers overflow.Peter Hinch
2017-07-21docs/pyboard/tutorial/amp_skin: Add example for playing large WAV files.Piotr Maliński
2017-07-19docs: Minor updates before 1.0.0Scott Shawcroft
2017-07-15docs,teensy: Use the name MicroPython consistently in documentationAlexander Steffen
2017-07-14docs: tweak css so a horizontal scroll bar shows up on the wide pinout ↵Scott Shawcroft
tables. Fixes #166
2017-07-04docs/uzlib: Update description of decompress() and mention DecompIO.Paul Sokolovsky
2017-07-03docs/pyboard: Move info about using Windows from topindex to general.Damien George
2017-07-02docs/esp8266/general.rst: Fix name of NTP module.Patrick O'Leary
The simple NTP client module is named "ntptime.py".
2017-07-03docs/uerrno: Document "uerrno" module.Paul Sokolovsky
2017-07-02docs/pyboard: Move hardware info into General Info chapter.Paul Sokolovsky
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.
2017-07-02docs/*_index: Drop "Indices and tables" pseudo-section.Paul Sokolovsky
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.
2017-07-02docs/conf.py: Set "version" and "release" to the same value.Paul Sokolovsky
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).
2017-07-02docs/replace.inc: Add |see_cpython|, to xref individual symbols from CPython.Paul Sokolovsky
The idea is to use it for each symbol in builtins.rst.
2017-07-02docs/library: Add CPython docs xref to each pertinent module.Paul Sokolovsky
Cross-reference text/link is implemented as RST substitution, so easy to consistently.
2017-07-02docs/conf.py: Add file for global replacements definition.Paul Sokolovsky
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.
2017-07-02docs/conf.py: Switch to "new" format of intersphinx_mapping.Paul Sokolovsky
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.
2017-07-02docs/topindex.html: Fix typo in "Glossary" heading.Damien George
2017-07-02docs: Add glossary.Paul Sokolovsky
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-02docs/ure: Elaborate doc, update markup to the latest conventions.Paul Sokolovsky
2017-07-01docs/builtins: Add AssertionError, SyntaxError, ZeroDivisionError.Paul Sokolovsky
Also, update heading of 1st sections to "Functions and types".
2017-07-01reference/index: Rewrite introduction paragraph to avoid confusion.Paul Sokolovsky
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-01docs/differences/index_template: Use consistent heading casing.Paul Sokolovsky
And in our case, "consistent" is where each word in the heading is *not* capitalized.
2017-07-01docs: Move topindex.html to templates/ subdir.Damien George
Later versions of jinja2 need it to be in this subdir, and earlier versions work with it here as well.
2017-07-01docs/conf.py: Add .venv dir to exclude_patterns.Paul Sokolovsky
It's useful to try different Sphinx versions using virtualenv/venv, so exclude a common venv dir name from Sphinx processing.
2017-07-01docs/constrained: Use markup adhering to the latest docs conventions.Paul Sokolovsky