5bb12793a0
update documentation and translations again
2018-10-11 22:19:46 +11:00
12e2a26406
Add new drivers to the doc page
2018-09-07 15:19:37 -07:00
0a02d77d64
Comment that it may vary by board
2018-07-30 15:20:12 -07:00
76971d9907
Wordsmith
...
For #1067
2018-07-30 15:04:40 -07:00
c76a4d477f
remove qemu-arm build; fix docs build bugs
2018-07-29 16:47:06 -04:00
bc760dd341
WIP: complete manual inspection of all significant changes
2018-07-23 21:34:25 -04:00
2809b4f9dd
Merge branch 'master' into micropython-25ae98f-merge
2018-07-16 19:36:40 -04:00
a20ab40ed2
Merge 3.0.0 final bugfixes and changes to master
2018-07-16 09:01:46 -04:00
7c219600a2
WIP: after merge; before testing
2018-07-11 16:45:30 -04:00
8e6feecf11
Merge pull request #863 from dhalbert/3.0_doc_updates
...
RTD documentation updates
2018-05-23 12:57:34 -07:00
bbdca2f352
typos in builtins.rst
2018-05-23 15:07:32 -04:00
6a63ff096a
ustruct -> struct in design_guide.rst
2018-05-23 15:05:38 -04:00
27551cbb4d
Fix ReadTheDocs build due to c2rst.
2018-05-23 11:53:00 -07:00
079c20e58e
use shared-bindings struct doc; remove docs/library one
2018-05-23 14:24:02 -04:00
20a13fa9fb
fix title underline
2018-05-22 21:21:19 -04:00
59615fc993
add caveat language re MicroPython libraries; other slight changes
2018-05-22 20:49:08 -04:00
e65cc07764
RTD documentation updates
2018-05-22 19:52:01 -04:00
6c955932f3
stm32/rtc: Don't try to set SubSeconds value on RTC.
...
The hardware doesn't allow it, instead the value is reset to 255 upon
setting the other calendar/time values.
2018-05-21 14:08:37 +10:00
90a09dba59
Merge branch 'master' of github.com:adafruit/circuitpython
2018-05-15 14:54:54 -04:00
567f3e30a7
Initial implementation of supervisor.reload()
2018-05-14 16:57:50 -04:00
321f882b6c
Merge pull request #834 from khawley/docs-makefile-fixes
...
Cleaning up and fixing the docs generation Makefile and README instructions
2018-05-14 16:09:39 -04:00
2ff7148d09
Update docs s/ucollections/collections/g
2018-05-14 14:31:56 -04:00
f9ae1ee172
Cleaning up and fixing the docs generation Makefile and README instructions
...
- moving Makefile to parent folder. This resolves some of the weird path/build issues
- remove trace references to cpydiff and original file (no longer used anywhere)
- converting SOURCEDIR to a changeable variable, passed through all sphinx-build calls
- adding path to conf.py, in case it moves again
- making `-v` default with VERBOSE
- making `-E` default with FORCE
- creating BASEOPTS to store all the dirs, paths, and settings, passing them to sphinx-build in one long chain, instead of individually
- updating README to use the make command as default. Also added text explaining some of the customization you can add into a make command
2018-05-14 11:02:25 -07:00
421b84af99
docs: Bump version to 1.9.4.
2018-05-11 16:39:59 +10:00
2955ada22f
docs: fix references to uhashlib
2018-05-06 12:31:54 -05:00
647ff387d9
docs: fix references to ubinascii
2018-05-03 09:34:43 -05:00
c7818032b1
docs/library: Add ussl module to library index for unix port.
2018-04-26 17:14:51 +10:00
c24b0a7f2b
docs/library/pyb.ADC: Fix typo of "prarmeter".
2018-04-20 15:54:09 +10:00
0600645944
docs/library/pyb.ADC: Remove outdated ADCAll code example.
2018-04-20 15:52:28 +10:00
b30e0d2f26
stm32/dac: Add buffering argument to constructor and init() method.
...
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-11 14:22:21 +10:00
aebd9701a7
stm32/adc: Optimise read_timed_multi() by caching buffer pointers.
2018-04-11 14:09:09 +10:00
4f40fa5cf4
stm32/adc: Add read_timed_multi() static method, with docs and tests.
2018-04-11 13:36:17 +10:00
8f11d0b532
docs/library/pyb.ADC.rst: Document new features for ADCAll.
2018-04-10 13:06:26 +10:00
f4563d11d1
Add four missing drivers
2018-03-27 14:25:14 -07:00
0abbafd424
stm32/can: Add "list" param to CAN.recv() to receive data inplace.
...
This API matches (as close as possible) how other pyb classes allow inplace
operations, such as pyb.SPI.recv(buf).
2018-03-19 15:12:24 +11:00
b7d576d69a
docs/library/pyb.CAN: Clean up documentation of data constants.
2018-03-16 18:29:43 +11:00
a25e6c6b65
stm32/can: Add CAN.info() method to retrieve error and tx/rx buf info.
2018-03-16 18:28:35 +11:00
d7e67fb1b4
stm32/can: Add CAN.state() method to get the state of the controller.
...
This is useful for monitoring errors on the bus and knowing when a restart
is needed.
2018-03-16 17:10:41 +11:00
1272c3c65d
stm32/can: Add CAN.restart() method so controller can leave bus-off.
2018-03-15 17:29:30 +11:00
823ca03008
stm32/can: Add "auto_restart" option to constructor and init() method.
2018-03-15 17:17:33 +11:00
d91a1989f5
docs/library/pyb.CAN: Update markup to use latest doc conventions.
2018-03-15 16:30:05 +11:00
0db49c37a4
docs: Fix some references and RST markup to eliminate Sphinx warnings.
2018-03-15 15:50:51 +11:00
4d3a92c67c
extmod/vfs_fat: Add file size as 4th element of uos.ilistdir tuple.
2018-03-12 12:26:36 +11:00
9cef2b03a7
docs/reference/repl.rst: Fix some minor errors in the REPL tutorial.
2018-03-09 16:14:58 +11:00
fa8f1a29e5
moved to top of list for alphabetical order
2018-03-07 23:10:25 -05:00
2de471950a
Added AM2320 to driver list
2018-03-07 17:25:43 -05:00
8359210e71
docs/library/uos: Document mount, umount, VfsFat and block devices.
2018-03-07 14:50:38 +11:00
63b003d523
docs/library/uos: Create sections for distinct parts and document uname.
2018-03-07 14:49:25 +11:00
402e71dcdd
Merge pull request #659 from tannewt/driver_page_update
...
Update driver links (for 3.x) including categories!
2018-03-06 21:41:47 -05:00
4f55205bf5
Fix links. Adding the en/latest/ circumvents a ReadTheDocs bug
...
which redirects projects incorrectly.
2018-03-06 18:24:56 -08:00
f16619ad3c
Update driver links including categories!
2018-03-06 16:54:13 -08:00
a5fb699d87
docs/library/micropython: Describe optimisation levels for opt_level().
2018-03-05 19:10:45 +11:00
6e09320b4c
docs/library/usocket: Make xref to uerrno explicitly a module reference.
2018-03-05 19:07:39 +11:00
ea633117d0
Remove bad c2rst and fix the other for sphinx 1.7.1
2018-02-27 18:08:49 -08:00
bf05183158
Merge remote-tracking branch 'adafruit/2.x' into merge_2x
2018-02-27 15:24:16 -08:00
c5fe610ba1
esp8266/modnetwork: Implement WLAN.status('rssi') for STA interface.
...
This will return the RSSI of the AP that the STA is connected to.
2018-02-26 16:41:13 +11:00
20dd3b1e43
Delete a bunch of docs, drivers and examples not relevant to CircuitPython.
...
This fixes #345 and fixes #215 .
2018-02-20 17:34:59 -08:00
e05fca4ef3
docs/library/ujson: Document dump() and load() functions.
2018-02-15 11:37:48 +11:00
9e8b7b1b63
docs/library/ujson: Update to conform with docs conventions.
...
The formatting of exception objects is done as per CPython conventions, eg:
:exc:`TypeError`
2018-02-15 11:31:34 +11:00
298b325f3e
docs/esp8266: Add a note concerning GPIO16 pull capabilities.
2018-02-15 11:15:12 +11:00
d072573226
docs/esp8266: Update PWM doc regarding clipping of min/max values.
2018-02-15 11:14:34 +11:00
2a3de8d185
Magnetometer values are also 3d vector of uT
...
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 ).
2018-02-11 23:15:01 +07:00
09bf06bc6b
More formal
2018-02-08 22:19:00 -08:00
f0232c99c5
Changes based on feedback in #600 .
2018-02-08 12:48:59 -08:00
15db02664d
Clarify style of attribute comments in the Design Guide.
...
And update the core attributes to match the style.
2018-02-07 13:08:42 -08:00
e708e87139
docs/library/pyb.rst: Add note about availability of USB MSC-only mode.
2018-02-01 15:52:49 +11:00
d201ac20af
Fix sensor table. ( #517 )
...
RST is very picky about spacing.
2018-01-08 20:38:43 -05:00
5cb361cf1f
Merge pull request #510 from dhalbert/3.0_merge_2.2.0
...
merge from 2.2.0 + fix up board defs
2018-01-04 20:59:59 -05:00
7d3bec46ae
Changing magnetic attribute in design guide ( #502 )
2018-01-02 20:03:20 -08:00
065e82015f
merge from 2.2.0 + fix up board defs
2018-01-02 21:25:41 -05:00
5de064fbd0
docs/library/index: Elaborate uPy libraries intro.
2017-12-23 21:21:08 +02:00
e37ccfe59b
docs/packages: Explicitly recommend usage of setuptools instead of distutils.
2017-12-16 10:42:30 +02:00
9251f1395e
docs/packages: Use "install_dir/" in examples.
2017-12-16 10:37:36 +02:00
02d2a0fb3a
docs/conf: Reference CPython 3.5 docs.
...
CPython 3.6 contains some backward incompatible changes, and further
version(s) are expected to have more. As we anyway implemente 3.4 with
some features of 3.5, refer to 3.5 docs to avoid confusion.
Examples of 3.6 backward incompatibilities:
https://docs.python.org/3.6/library/json.html#json.dump
https://docs.python.org/3.6/library/json.html#json.load
> Changed in version 3.6: All optional parameters are now keyword-only.
https://docs.python.org/3.6/library/functions.html#type
> Changed in version 3.6: Subclasses of type which don’t override
> type.__new__ may no longer use the one-argument form to get the
> type of an object.
https://docs.python.org/3.6/library/collections.html#collections.namedtuple
> Changed in version 3.6: The verbose and rename parameters became
> keyword-only arguments.
2017-12-16 01:22:46 +02:00
448d93a04a
docs/glossary: micropython-lib: Clarify wording.
2017-12-15 00:11:02 +02:00
36ec29d4e8
Documentation Updates (mcu.delay() and Design Guide) ( #481 )
...
/docs/design_guide: added links to firmware build learning guides for SAMD21 & ESP8266. Changes were placed in the "Adding native modules" section, since that seemed to me the best place based on target audience.
Updated documentation for `delay()` which fixes #243 .
2017-12-14 10:02:43 -08:00
bf73ee114f
docs/packages: mpy_bin2res no longer required to create resources.
...
Everything happens automagically with overridden "sdist" from
sdist_upip.py.
2017-12-14 18:28:10 +02:00
46b35356e1
extmod/modframebuf: Add 8-bit greyscale format (GS8).
2017-12-14 17:36:13 +11:00
34247465c3
extmod/modframebuf: Add 2-bit color format (GS2_HMSB).
...
This format is used in 2-color LED matrices and in e-ink displays like
SSD1606.
2017-12-14 17:13:02 +11:00
1e2b78111b
docs/esp8266/tutorial: Fix typo, change -> changed.
2017-12-13 17:30:02 +11:00
54cd6e3e4b
docs/packages: Add quick "Creating distribution packages" section.
...
Needs more details.
2017-12-13 00:12:37 +02:00
c60fc670ea
docs/reference/packages: Add chapter on distribution packages and deployment.
...
A long overdue overview of preparing packages, installing them with upip,
freezing, dealing with resources. Initial version, more iterations required.
2017-12-11 00:08:41 +02:00
ca8034d6b8
docs/glossary: Clarify wording for "baremetal".
2017-12-06 00:08:24 +02:00
3ff7040c8a
docs/library: Add xrefs to "stream" dictionary entry for many modules.
2017-12-04 18:36:20 +02:00
155ec21e49
docs/glossary: Describe string interning.
2017-12-04 01:01:03 +02:00
8175f1608e
docs/glossary: Describe "stream" term.
2017-12-03 18:56:18 +02:00
140acc9a32
docs/uerrno: Fix xref-vs-code markup.
2017-12-03 15:50:37 +02:00
4fee35a32c
docs/glossary: Describe the callee-owned tuple concept.
2017-12-03 15:08:39 +02:00
b31c2ea748
fix markdown-styled link in design_guide.rst
2017-12-02 22:43:48 -08:00
cb9da2279b
docs/uselect: ipoll: Fix grammar/wording of one-shot flag description.
2017-11-30 20:32:49 +02:00
7d25a19220
docs/library/utime: Fix incorrect example with ticks_diff args order.
...
The parameter order in the example for ticks_diff was incorrect. If it's
"too early" that means that scheduled time is greater than current time and
if it's "running late" then scheduled time would be less than current time.
2017-11-30 14:56:08 +11:00
f59c6b48ae
docs/uselect: Describe POLLHUP/POLLERR semantics in more details.
...
Per POSIX, http://pubs.opengroup.org/onlinepubs/9699919799/functions/poll.html
these flags aren't valid in the input eventmask. Instead, they can be
returned in unsolicited manner in the output eventmask at any time.
2017-11-26 09:58:19 +02:00
50cffcfe2c
docs/uctypes: Tweak descriptor reference to hopefully be easier to follow.
...
Put offset first in OR expressions, and use "offset" var instead of
hardcoded numbers. Hopefully, this will make it more self-describing
and show patterns better.
2017-11-25 09:02:08 +02:00
c23cc4cc81
docs/uctypes: Typo/article fixes.
2017-11-25 09:01:11 +02:00
067bf849d2
docs/uselect: poll: Explicitly specify that no-timeout value is -1.
2017-11-23 18:03:32 +02:00
ec1e9a10a7
docs: Add notes on heap allocation caused by bound method refs.
2017-11-23 11:35:58 +11:00
31550a52e4
docs/library/network: Enhance AbstractNIC.status to take an argument.
...
The argument is optional and if given should be a string naming the
status variable to query.
2017-11-16 14:48:04 +11:00
065a319100
Update info about erasing CIRCUITPY to include flash erasers for non-… ( #427 )
...
Update info about erasing CIRCUITPY to include flash erasers for non-Express boards.
2017-11-14 07:58:26 -08:00
579b86451d
docs/_thread: Add a placeholder docs for _thread module.
...
Doesn't list specific API calls yet, the purpose is to let user know that
the module exists.
2017-11-10 00:09:43 +02:00
5b1b80a8db
docs/ure: Emphasize not supported features more.
...
Plus, additional descriptions/formatting.
2017-11-08 00:24:39 +02:00
Nick Moore
Scott Shawcroft
Scott Shawcroft
Dan Halbert
Scott Shawcroft
Damien George
Roy Hooper
bildzeitung
Karin Hawley
Jeff Epler
Peter Hinch
T S
Tom Collins
Kattni
Olivier Ortigues
Mika Tuupola
Dan Conley
Paul Sokolovsky
sommersoft
Petr Viktorin
Ryan Finnie
Christopher Hiller
Paul Carver