summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2016-08-07docs/esp8266/tutorial/intro: Add anchor for link from quickeref.Paul Sokolovsky
2016-08-07docs/esp8266/quickref: Link to installation instructions.Paul Sokolovsky
2016-08-07docs/esp8266/intro: Add troubleshooting section.Paul Sokolovsky
Tries to summarize most of the issues we've seen so far.
2016-08-07docs/esp8266/intro: Rename to "Getting started" from "Introduction".Paul Sokolovsky
People tend to skip introductions (everyone knows what esp8266 is, right?), so try to do A/B testing with a title inviting to read it.
2016-08-07esp8266/tutorial/intro: Reword para abou -fm dio switch.Paul Sokolovsky
Not all NodeMCU boards require it.
2016-08-07docs/library/index: Include array module in ToC.Paul Sokolovsky
2016-08-07docs/array: Document array module.Paul Sokolovsky
2016-08-02docs: Spelling mistakesMike Causer
2016-08-01docs: Add DHT to ESP8266 Quick Ref and TutorialMike Causer
2016-07-10docs: Bump version to 1.8.2.v1.8.2Damien George
2016-06-26docs/library: Fix typo in docs for usocket.listen().Martin Müller
2016-06-19docs/conf.py: Exclude cmath from modindex for wipy.Paul Sokolovsky
2016-06-18docs/sys: print_exception: Fixes/clarifications.Paul Sokolovsky
2016-06-18docs/select: Add an article.Paul Sokolovsky
2016-06-14docs: Rebuild docs from scratch, as required for proper only:: handling.Paul Sokolovsky
Docs are now by default rebuilt from scratch, as required to build conditionalized (i.e. using only:: directive) docs across different output types. We have pretty small docset, so that's still rather fast. However, if that's a concern, incremental rebuilds can be used by passing "FORCE=" (nothing after =) as a make parameter. This will work when using the same output type (e.g. only "html").
2016-06-12docs/conf.py: Active sphinx_selective_exclude extensions.Paul Sokolovsky
For modindex_exclude extension, per-port module excludes are also added. With these changes, it's possible to generate docs for a particular port devoid of any superfluous and unrelated content, including in indexes and full-text search - with small caveat: when generating PDF docs after HTML, or vice-versa cached internal doctree representation (build/*/doctrees/) must be removed first.
2016-06-12docs: Add sphinx_selective_exclude extension suite.Paul Sokolovsky
Designed specifically to workaround issues we were facing with generating multiple conditionalized output docsets from a single master doctree. Extensions were factored out into a separate project, based on the fact that many other Sphinx users experience similar or related problems: https://github.com/pfalcon/sphinx_selective_exclude Corresponds to the 182f4a8da57 upstream revision.
2016-06-10docs/sys: Detailed description of print_exception() diff from traceback module.Paul Sokolovsky
2016-06-09docs/uctypes: Improve documentation.Paul Sokolovsky
Seealso and Limitations sectiosn added, better formatting and grammar.
2016-06-09docs/machine*: Remove explicit targets and "machine." prefixes on classes.Paul Sokolovsky
With currentmodule:: set properly, none are needed. Extra "machine." prefix produces wrong indexing data.
2016-06-09docs/machine.Pin: Disambiguate object call method.Paul Sokolovsky
2016-06-09docs/library/index: Add builtins.rst.Paul Sokolovsky
2016-06-09docs/builtins: Enumerate all builtin functions implemented.Paul Sokolovsky
Based on unix version. No descriptions so far.
2016-06-08docs/pyb.Pin: Sort .af() and .af_list() methods together.Paul Sokolovsky
2016-06-08docs/pyb.*: Use proper class case in method headers.Paul Sokolovsky
Class designator will be used as is in indexes, so must match actual class name.
2016-06-08docs/pyb.ExtInt,pyb.Pin: Mark up class methods as such.Paul Sokolovsky
2016-06-08docs/pyb.Pin: af_list() is a normal method, not a class method.Paul Sokolovsky
2016-06-08docs/pyb.CAN: Mark CAN.initfilterbanks() as classmethod explicitly.Paul Sokolovsky
2016-06-08docs/machine.Pin: Add class designator to all constants.Paul Sokolovsky
This makes rendered docs to not provide incorrect information and consistent with how it's down for other machine classes.
2016-06-08docs/machine.*: Use proper class case in method headers.Paul Sokolovsky
Class designator will be used as is in indexes, so must match actual class name.
2016-06-08docs/machine.UART: Cleanup pyboard section.Paul Sokolovsky
2016-06-08docs/machine.Pin: Remove explicit target.Paul Sokolovsky
With currentmodule:: support, all targets should be generated properly by Sphinx.
2016-06-08docs/pyb.*: Add "currentmodule:: pyb" directive.Paul Sokolovsky
Makes sure that classes described in these separate files are properly designated as belonging to "pyb" module in indexes.
2016-06-08docs/machine.*: Add "currentmodule:: machine" directive.Paul Sokolovsky
Makes sure that classes described in these separate files are properly designated as belonging to "machine" module in indexes.
2016-06-07docs/library/machine.Pin: Mention GPIO and cross-link .value() function.Paul Sokolovsky
2016-06-07docs/usocket: There must be empty line after .only:: .Paul Sokolovsky
2016-06-07docs/ure: Typo fix.Paul Sokolovsky
2016-06-07docs/esp.socket: Remove unused file.Paul Sokolovsky
2016-06-07docs/library/network: wipy: Fix literal block indentation.Paul Sokolovsky
2016-06-06docs: Add link to PDF version of docs in sidebar.Damien George
Requires a link of the form: <BASEURL>/<lang>/<ver>/micropython-<port>.pdf
2016-06-06docs/esp8266/tutorial/network_basics: Minor typo fix, ap becomes ap_if.Ben Hagen
2016-06-03docs: Bump version to 1.8.1.v1.8.1Damien George
2016-06-03docs/esp8266/general: Add note about RTC overflow.puuu
2016-06-02docs/esp8266/quickref: Update WebREPL section for 1.8.1 release.Paul Sokolovsky
WebREPL is much more stable now.
2016-06-02docs/library/index: Fix grammar and spelling in intro paragraph.Damien George
2016-06-02docs/wipy/tutorial: Add note about screen key bindings on OS X.Marcel Stör
2016-06-02docs/README: Add some hints for PDF docs generation.Paul Sokolovsky
2016-06-02docs/library/index: Add intro paragraph regarding availability of modules.Paul Sokolovsky
This introductions makes explicit the fact that whenever possible, the documentation describes full MicroPython functionality, and arbitrary functions/classes/modules may be missing in a paricular port or build.
2016-06-01esp8266/general: Typo/grammar fixes.Paul Sokolovsky
2016-06-01esp8266/quickref: Use local image of Adafruit Huzzah board.Paul Sokolovsky
Using remote image causes problems with tools (partly because the image is semi-firewalled and can't be accessed by arbitrary tools).
generated by cgit v1.2.3 (git 2.46.0) at 2025-08-10 02:10:01 +0000