aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2018-10-13lib/utils/pyexec: Forcefully unlock the heap if locked and REPL active.Damien George
Otherwise there is really nothing that can be done, it can't be unlocked by the user because there is no way to allocate memory to execute the unlock. See issue #4205 and #4209.
2018-10-05docs/uselect: Describe more aspects of poll.register/modify behavior.Paul Sokolovsky
E.g., register() can be called again for the same object, while modify() will raise exception if object was not register()ed before.
2018-10-01docs/wipy: Fix links to network.Server, and markup for boot.py.Damien George
2018-10-01docs: Remove sphinx_selective_exclude, it's no longer used.Damien George
2018-10-01docs: Unify all the ports into one set of documentation.Damien George
With this commit there is now only one entry point into the whole documentation, which describes the general MicroPython language, and then from there there are links to information about specific platforms/ports. This commit doesn't change content (almost, it does fix a few internal links), it just reorganises things.
2018-09-27docs/library/network: Make AbstractNIC methods layout correctly.Damien George
2018-09-27docs/library/network: Move specific network classes to their own file.Damien George
All concrete network classes are now moved to their own file (eg network.WLAN.rst) and deconditionalised (remove ..only:: directives). This makes the network documentation the same for all ports. After this change there are no more "..only::" directives for different ports, and the only difference among ports is the very front page of the docs.
2018-09-26docs/library/machine.SPI: Add note about baudrate imprecision.Peter Hinch
2018-09-20docs/pyboard: Fix to use Sphinx style for internal/external links.Damien George
2018-09-20docs/library/pyb: Add deprecation warning for mount and old block proto.Peter Hinch
pyb.mount(None, mountpoint) functionality is also removed and replaced by uos.umount.
2018-08-14docs/library/machine.UART.rst: Specify optional txbuf and rxbuf args.Damien George
If a port would like to expose the configuration of transmit and/or receive buffers then it can use these arguments.
2018-08-04docs/library/machine.I2C.rst: Clarify availability of primitive I2C ops.Peter Hinch
2018-07-31docs: Move WiPy specific Timer class to separate doc file.Damien George
The WiPy machine.Timer class is very different to the esp8266 and esp32 implementations which are better candidates for a general Timer class. By moving the WiPy Timer docs to a completely separate file, under a new name machine.TimerWiPy, it gives a clean slate to define and write the docs for a better, general machine.Timer class. This is with the aim of eventually providing documentation that does not have conditional parts to it, conditional on the port. While the new docs are being defined it makes sense to keep the WiPy docs, since they describe its behaviour. Once the new Timer behaviour is defined the WiPy code can be changed to match it, and then the TimerWiPy docs would be removed.
2018-07-20docs/library/machine: Remove conditionals in machine class index.Damien George
The machine module should be standard across all ports so should have the same set of classes in the docs. A special warning is added to the top of the machine.SD class because it is not standardised and only available on the cc3200 port.
2018-07-20docs/reference/index: Remove conditional for inline asm docs.Damien George
The heading of this section makes it clear it is for Thumb-2 architectures only.
2018-07-20docs/library/index: Add hint about using help('modules') for discovery.Damien George
2018-07-20docs/library/index: Remove all conditionals from library index.Damien George
It's fair to just provide a link to all available modules, regardless of the port. Most of the existing ports (unix, stm32, esp8266, esp32) share most of the same set of modules anyway, so no need to maintain separate lists for them. And there's a big discussion at the start of this index about modules not being available on a given port. For port-specific modules, they can also be listed unconditionally because they have headings that explicitly state they are only available on certain ports.
2018-07-18docs/library/machine: Remove conditional docs for rng function.Damien George
And instead list its availability explicitly.
2018-07-18docs/library/machine: Remove conditional docs for wake_reason function.Damien George
And instead list its availability explicitly.
2018-07-18docs/library/machine.UART: Remove conditional docs for wipy port.Damien George
The UART.init() method is now included unconditionally and its wording adjusted to better describe ports other than the cc3200. UART.irq() is also included unconditionally, but this is currently only available on the WiPy target.
2018-07-18docs/library/pyb.DAC: Fix typo in markup to balance quotes.Damien George
2018-07-18docs/library: Remove "only" directive from all pyb module docs.Damien George
By virtue of its name, the pyb module would only be available on a pyboard and so does not need to have conditional "only" directives throughout its documentation. These conditionals were added mostly in cfcf47c0644952358e1a260db159e807872a37e6 in the initial development of the cc3200 port, which had the pyb module before it switched to the machine module. And wipy only conditionals were removed from the pyb module documentation in 4542643025c77a7272bde348b89d5039aea28d23, so there's no need to retain any more conditionals.
2018-07-10docs/pyboard: For latex build, use smaller quickref jpg, and no gifs.Damien George
The latexpdf target needs images that fit on the page, and does not support gifs.
2018-07-02docs/ure: Document some more supported regex operators.Damien George
2018-07-02docs/ure: Document sub(), groups(), span(), start() and end().Damien George
2018-06-28docs/uos: Make it clear that block device block_num param is an index.Damien George
2018-06-27extmod/moducryptolib: Optionally export MODE_* constants to Python.Yonatan Goldschmidt
Allow including crypto consts based on compilation settings. Disabled by default to reduce code size; if one wants extra code readability, can enable them.
2018-06-27docs/usocket: Minor fixes to grammar of getaddrinfo.Damien George
2018-06-27docs/usocket: getaddrinfo: Describe af/type/proto optional params.Paul Sokolovsky
These can be optionally specified, but all ports are expected to be able to accept them, at the very least ignore, though handling of "type" param (SOCK_STREAM vs SOCK_DGRAM) is recommended.
2018-06-27docs/ucryptolib: Add docs for new ucryptolib module.Paul Sokolovsky
2018-06-26docs/library: Add documentation for ucollections.deque.Damien George
2018-06-25docs/esp8266: Fix minor typo in "certificates".jcea
2018-05-21stm32/rtc: Don't try to set SubSeconds value on RTC.Damien George
The hardware doesn't allow it, instead the value is reset to 255 upon setting the other calendar/time values.
2018-05-11docs: Bump version to 1.9.4.Damien George
2018-04-26docs/library: Add ussl module to library index for unix port.Damien George
2018-04-20docs/library/pyb.ADC: Fix typo of "prarmeter".Damien George
2018-04-20docs/library/pyb.ADC: Remove outdated ADCAll code example.Peter Hinch
2018-04-11stm32/dac: Add buffering argument to constructor and init() method.Damien George
This can be used to select the output buffer behaviour of the DAC. The default values are chosen to retain backwards compatibility with existing behaviour. Thanks to @peterhinch for the initial idea to add this feature.
2018-04-11stm32/adc: Optimise read_timed_multi() by caching buffer pointers.Damien George
2018-04-11stm32/adc: Add read_timed_multi() static method, with docs and tests.Peter Hinch
2018-04-10docs/library/pyb.ADC.rst: Document new features for ADCAll.T S
2018-03-19stm32/can: Add "list" param to CAN.recv() to receive data inplace.Damien George
This API matches (as close as possible) how other pyb classes allow inplace operations, such as pyb.SPI.recv(buf).
2018-03-16docs/library/pyb.CAN: Clean up documentation of data constants.Damien George
2018-03-16stm32/can: Add CAN.info() method to retrieve error and tx/rx buf info.Damien George
2018-03-16stm32/can: Add CAN.state() method to get the state of the controller.Damien George
This is useful for monitoring errors on the bus and knowing when a restart is needed.
2018-03-15stm32/can: Add CAN.restart() method so controller can leave bus-off.Damien George
2018-03-15stm32/can: Add "auto_restart" option to constructor and init() method.Damien George
2018-03-15docs/library/pyb.CAN: Update markup to use latest doc conventions.Damien George
2018-03-15docs: Fix some references and RST markup to eliminate Sphinx warnings.Damien George
2018-03-12extmod/vfs_fat: Add file size as 4th element of uos.ilistdir tuple.Tom Collins