aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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
2017-06-30docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions.Paul Sokolovsky
2017-06-30docs/topindex.html: Remove link to wipy.io, it's no longer available.Damien George
2017-06-29docs/{framebuf,usocket}: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-28docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-27docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-27docs: Move all ports docs to the single ToC.Paul Sokolovsky
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.
2017-06-26docs/library/gc: Fix grammar and improve readability of gc.threshold().Damien George
2017-06-26docs/esp8266/tutorial/intro: Fix some grammatical typos.Damien George
2017-06-26docs/ref/speed_python: Update and make more hardware-neutral.Paul Sokolovsky
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-26docs/network: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-25docs/machine*: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-25docs/lcd160cr: Group related constants together. Use full sentences.Paul Sokolovsky
Per the latest docs conventions.
2017-06-25docs/conf.py: Set default_role = 'any'.Paul Sokolovsky
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).
2017-06-25docs/utime: Use markup adhering to the latest conventions.Paul Sokolovsky
2017-06-25docs/lcd160cr: Use markup adhering to the latest conventions.Paul Sokolovsky
2017-06-25docs/btree: Use markup adhering to the latest conventions.Paul Sokolovsky
2017-06-24docs/builtins: List builtin exceptions.Paul Sokolovsky
If for nothing else, then at least to cross-reference them.
2017-06-24docs/gc: Document gc.threshold() function.Paul Sokolovsky
2017-06-24docs/gc: Mark mem_alloc()/mem_free() as uPy-specific.Paul Sokolovsky
2017-06-24docs/conf.py: Include 3 levels of ToC in latexpdf output.Paul Sokolovsky
Instead of default 2. 3 are required to access description of individual library modules.
2017-06-23docs/esp8266/tutorial/intro: Sphinx requires blank lines around literal blocks.Paul Sokolovsky
At least, Sphinx 1.3.6.
2017-06-23docs/esp8266/tutorial/intro: Discourage use of 512kb firmwares.Paul Sokolovsky
This follows similar warnings in other parts of docs.
2017-06-23docs/license: Update copyright year.Paul Sokolovsky
2017-06-16docs/select: Rename to uselect, to match the actual module name.Paul Sokolovsky
Also, add ipoll() documentation and markup changes to comply with CPython usage.
2017-06-15stmhal: Add .value() method to Switch object, to mirror Pin and Signal.Damien George
2017-06-11docs/btree: Typo/wording fixes.Paul Sokolovsky
2017-06-11docs/btree: Add hints about opening db file and need to flush db.Paul Sokolovsky
2017-06-11docs: Bump version to 1.9.1.Damien George
2017-06-04docs/network: First step to describe standard network class interface.Paul Sokolovsky
This adds description of implied AbstractNIC base class, which should be "subclasses" and implemented by a particular network device class. This is just an initial step in that direction, the API and description will be elabotated further.
2017-06-03docs/machine: Sort machine classes in logical order, not alphabetically.Paul Sokolovsky
The list starts with the simplest functionality - GPIO, proceeds to communication interfaces (UART, SPI, I2C), the to time(r) related things, then everything else.
2017-06-03docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc.Paul Sokolovsky
This patch also unconditionalizes uos.dupterm(), though exact interface and semantics is yet to be defined.
2017-06-03docs/uos: Deconditionalize, remove minor port-specific details.Paul Sokolovsky
For a couple of ports, there was information which directory is set as current after boot. This information doesn't belong to "uos" module, and is moved to boards' references (which actually already contained information on which directory is chosen for boot, even if without explicit mentioning that it becomes current directory, which is now done).
2017-06-03docs/network: Move confusingly-named cc3200 Server class to its reference.Paul Sokolovsky
cc3200 port has network.Server class to control behavior of builtin Telnet/FTP server of that port.
2017-06-02docs/esp8266/quickref: Polish Pin.on()/off() examples.Paul Sokolovsky
2017-05-30docs/esp8266: Consistently replace Pin.high/low methods with .on/off.Paul Sokolovsky
2017-05-29docs/machine.Pin: Add on() and off() methods.Paul Sokolovsky
2017-05-29docs/machine.Pin: Remove out_value() method.Paul Sokolovsky
This method isn't implemented in any port. It seemed to have originated in cc3200 port, but actually never was implemented there either. In general case, it's impossible to implement this method (for example, for a perfect GPO, which has only output latch without any feedback look into a CPU).
2017-05-29various: Spelling fixesVille Skyttä
2017-05-26docs: Bump version to 1.9.Damien George
2017-05-21library/machine.Pin: Remove .id() method and .board class attr.Paul Sokolovsky
Both aren't part of generic Hardware API: It's impossible to implement .id() method in a generic case (e.g., when Pin is instantiated by the underlying OS/RTOS). .board attribute is an obvious space hog which instead can be implemented on Python level if needed.
2017-05-19docs/library/machine.UART: Update and improve uart.any() docs.Damien George
2017-05-18docs/library/micropython: Document the newer micropython functions.Damien George
2017-05-17drivers/display/lcd160cr: Fix get_line method and enhance screen_dump.Damien George
The docs are updated and describe the new behaviour of these methods.
2017-05-17docs: Change single occurrence of "Micropython" to "MicroPython".Damien George
2017-05-15docs/library/index: Add important summary of the intro section as warning.Paul Sokolovsky
To make them harder to miss.
2017-05-14docs/machine.Signal: Add initial draft description of Signal class.Paul Sokolovsky
2017-05-14docs/machine.Pin: There's no toggle() method in MicroPython hardware API.Paul Sokolovsky
May be a port-specific method, not portable, not part of the official specification.
2017-05-10docs/library/uos: Add description of uos.ilistdir() function.Damien George