601cfea6a3
docs: Update license date range to include 2015.
2015-06-04 23:47:10 +01:00
7ca1bd314b
docs: Generate a separate docs build for each port.
...
Using Damien's approach where conf.py and topindex.html are
shared by all ports.
2015-06-04 23:44:35 +01:00
32ce72cb9e
docs/uctypes: Typo fix.
2015-06-02 10:35:06 +03:00
f8bce131c0
docs/uctypes: Fix API description errors.
...
"Structure class" is its descriptor, encoded as a dictionary. Then,
uctypes.struct() instantiates an actual object, and thus requires memory
address.
2015-06-02 10:30:01 +03:00
78ccb44a90
docs: Document esp module for ESP8266.
...
I document as much as I could guess from experiments and reading the
code for the ``esp`` module for the ESP8266 port of Micropython.
For now the tag has to be set manually with -t option when building,
when we have properly split documentation, there will be a separate
config file for esp8266 with that the tag "port_esp8266" set.
To build use:
make SPHINXOPTS="-t port_esp8266" html
2015-05-30 12:49:58 +01:00
3ad94d6072
extmod: Add ubinascii.unhexlify
...
This also pulls out hex_digit from py/lexer.c and makes unichar_hex_digit
2015-05-20 09:29:22 +01:00
d7b7d5f6ee
docs: Bump version to 1.4.3.
2015-05-16 21:26:43 +01:00
0bfc57022d
docs: Document USB_VCP file-like methods.
2015-05-13 20:42:12 +01:00
c7df9c6c47
stmhal: Add os.rename function.
2015-05-12 23:43:11 +01:00
5df81de7af
sthmal/rtc.c: Add calibration() method to get/set RTC fine-tuning value.
2015-05-11 23:48:39 +01:00
dea853d3a3
docs: Document pyb.stop, pyb.standby and pyb.RTC.wakeup.
2015-04-21 22:35:17 +01:00
43d56f9ba9
docs: Bump version to 1.4.2.
2015-04-21 12:51:14 +00:00
e3cd154317
stmhal: Add support for sending and receiving CAN RTR messages.
2015-04-18 14:53:00 +01:00
7d5e34287c
stmhal: Allow sending CAN messages with timeout=0.
...
Thanks to Henrik Sölver for this patch.
2015-04-16 23:52:43 +01:00
feff00e1a5
Add .gitattributes file to force text line endings to LF.
...
Some files are excluded, otherwise a whole lot of files need converting.
2015-04-16 22:23:56 +01:00
e97dddcdca
docs: Document pyb.main function to set main script.
2015-04-09 10:08:25 +01:00
0f6424efda
docs: Bump version to 1.4.1.
2015-04-04 17:41:11 +01:00
344057ac50
docs: uctypes: Bullet list formatting fixes.
2015-03-31 01:29:07 +03:00
9d2c0c231c
docs: uctypes: Describe how to instantiate struct objects.
2015-03-31 01:16:14 +03:00
e178ef2520
docs: Add additional example/note for Timer's callback usage.
...
Add example: using named function for the Timer's callback.
Add note: improving traceback inside interrupt timers.
2015-03-30 00:43:04 +01:00
47098efbda
docs: Provide initial documentation for micropython module.
2015-03-30 00:32:29 +01:00
64e8b62291
docs: Bump version to 1.4.
2015-03-29 18:01:19 +01:00
c260836beb
docs: uctypes: Describe bytes_at(), bytearray_at().
2015-03-27 00:19:23 +02:00
ec1b1cf834
docs: uctypes: Describe couple more functions.
2015-03-24 22:42:54 +02:00
b4c9a25eab
stmhal: Add support for quadrature encoder mode to pyb.TimerChannel.
2015-03-09 13:23:14 +00:00
b57b56f293
docs: Update pyb.Timer.rst to fix pulse widths that exceed the period.
2015-03-09 12:14:32 +00:00
4fddbe5ab6
docs: Correct the documentation for math.frexp.
2015-02-23 22:15:11 +00:00
1babb6d0c7
docs: Update timer tutorial to reflect new behaviour of timer.
2015-02-23 22:14:54 +00:00
3527085587
pyb.UART.rst: Clean up note about stream protocol support.
2015-02-22 13:36:35 +02:00
77fc276c08
stmhal: For UART, check that baudrate is within 5% of desired value.
...
Also includes documentation about minimum baudrate.
Addresses issue #1090 .
2015-02-22 00:26:49 +00:00
f80f1a7077
stmhal: Add support for CAN rx callbacks.
2015-02-15 03:10:53 +00:00
baafb290ad
stmhal: Add uart.sendbreak() method, to send a break condition.
2015-02-13 19:04:24 +00:00
d39c7aa517
stmhal: Add Python-configurable USB HID mode.
...
Different HID modes can be configured in Python. You can either use
predefined mouse or keyboard, or write your own report descriptor.
2015-02-13 14:02:51 +00:00
79dc0a0886
docs: Bump version to 1.3.10.
2015-02-13 13:26:44 +00:00
552f7c40a0
docs: Bump version to 1.3.9.
2015-01-25 00:10:07 +00:00
73533247cb
docs: Fix frequency info for DAC.triangle.
2015-01-20 23:56:10 +00:00
3990dcfcd7
docs: Add note about maximum frequency of busses.
2015-01-08 22:54:26 +00:00
7a0636e80a
docs: Add initial "uctypes" modules docs. WIP.
2015-01-08 00:17:10 +02:00
b27c9876ea
docs: For Windows USB CDC driver setup, add link to existing PDF guide.
2015-01-06 16:09:49 +00:00
ddbcc79550
docs: Add quickref info about Servo; improve Servo docs.
2015-01-01 18:00:45 +00:00
ce5b5caf8c
Add a command for converting the WAV files
...
Add a command for converting the WAV files to the amp skin tutorial, so that people can use their own files easily.
2015-01-01 17:56:05 +00:00
96e22154d7
docs: Bump version to 1.3.8.
...
Should have done it before tagging...
2014-12-29 00:04:59 +00:00
7690b13953
stmhal: Add ability to mount custom block device.
2014-12-27 20:20:51 +00:00
90cd6cd987
docs: Add mention about using USB charger when resetting the filesystem.
...
It seems the Mac will happily wipe out at least some of the data on
a freshly reset filesytem, if the filesystem was reset while plugged
into the Mac.
2014-12-23 13:22:32 +00:00
a37656c132
docs: Make admonition for CPy-difference use "attention" class.
...
This renders it in yellow/orange box on RTD server.
2014-12-22 13:42:30 +00:00
7b80d908bf
docs: Add RTD local_settings file, to add custom templates.
2014-12-21 11:21:06 +00:00
9b561a7c0d
docs: Add custom CSS file, with code for admonition.
2014-12-21 00:22:49 +00:00
6d3ae569cf
docs: Add CPy diff note for print_exception; embellish sys.platform.
2014-12-19 22:10:38 +00:00
5cf7ac7309
Fix leds.rst
...
N (mod 4) is 0..3
2014-12-18 00:06:48 +03:00
9642846d71
docs: Define more clearly the behaviour of LED methods.
...
Addresses issue #1006 .
2014-12-16 11:55:46 +00:00
6c3fc74656
docs: Add sys.print_exception().
2014-12-10 20:31:38 +02:00
b66a31c42c
stmhal: Allow SPI.init to specify prescaler directly; improve SPI docs.
2014-12-08 21:34:07 +00:00
008251180d
stmhal: Enhance pyb.freq to configure bus (AHB, APB1, APB2) freqs.
...
This is useful if you need precise control over the speed of
peripherals (eg SPI clock).
2014-12-08 21:32:55 +00:00
41c07d5b80
docs: uzlib: Typo fix.
2014-12-05 02:08:30 +02:00
adf4c4cea8
docs: Add quick docs for uzlib.
2014-12-05 00:40:35 +02:00
c0b3d4540b
docs: Update network docs to reflect changes to code.
2014-12-04 19:43:56 +00:00
3a5352b483
docs: Add skeleton docs for ure module.
2014-12-04 00:07:00 +02:00
578ea6d4a5
docs: Add links to LCD and AMP skin schematics.
2014-12-02 12:32:39 +00:00
d8fd3103fa
docs: Add quick docs for ubinascii.
2014-12-02 01:51:56 +02:00
d96a916405
docs: Add quick docs for uhashlib.
2014-12-02 00:53:19 +02:00
7f0699eedf
docs: Sort "micro-library" module list alphabetically.
2014-12-01 20:42:38 +02:00
d8c2b2a1c4
Update documentation for the CAN class
2014-11-30 01:04:56 +00:00
19fb1b4dd7
stmhal: Add USB_VCP.setinterrupt method, to disable CTRL-C.
2014-11-29 15:23:21 +00:00
722fab7c2a
docs: Bump version to 1.3.7.
2014-11-28 17:48:48 +00:00
9aae41121b
Update uheapq.rst
...
Erratum in froh.
2014-11-28 17:32:29 +00:00
5228854f0e
docs: Fix RTD build configuration.
...
ReadTheDocs needs the root directory in its search path so it finds
topindex.html.
2014-11-15 21:33:07 +00:00
d1b42d7b51
stmhal: Improve CAN init so that it can take sjw, bs1, bs2 args.
...
Also update docs to explain how CAN baudrate is determined.
2014-11-15 21:28:14 +00:00
aec189a5ba
docs: Add optional sphinx_rtd_theme; add docs build instructions.
...
The sphinx_rtd_theme is used by ReadTheDocs to render a pretty looking
documentation. If you have this theme installed locally then your
locally-compiled docs will look exactly like the published
documentation. Otherwise it falls back to the default theme.
2014-11-15 19:01:19 +00:00
ca0b0cb83f
Document parameter "data" of i2c.mem_read() more clear
...
Hi,
i would like to add a little clarification to the parameter "data" of i2c.mem_read(): I misunderstood
``data`` can be an integer or a buffer to read into
as "i can give a integer variable to read a integer into" . This pull-request adds the following clarification:
``data`` can be an integer (number of bytes to read) or a buffer to read into
Thanks for your great work!
Best wishes,
Matthias
2014-11-15 18:31:37 +00:00
d8474d3617
docs: select: Describe extra details.
2014-11-09 01:48:05 +02:00
ff8d0e071c
docs: Bump version to 1.3.6.
...
This needs to be done before actually tagging the new version.
2014-11-04 19:04:12 +00:00
0e3722137f
docs: Update front page to display date of last update.
2014-11-04 18:51:29 +00:00
8e701604d5
docs: Add links from quickref to pyb classes.
2014-11-04 18:25:20 +00:00
bc0bc764fc
docs: Add debounce tutorial; order Pin methods; add pull resistor info.
2014-11-04 18:07:06 +00:00
183ac71dc8
docs: Add pdf size info to datasheet links.
2014-11-03 22:21:25 +00:00
1e3fde0a10
docs: Add skin imgs; change external links to micropython.org/resources.
2014-11-03 22:14:23 +00:00
72165c01f0
docs: Adjust table spacing in topindex page.
2014-11-03 20:48:43 +00:00
bfd11a35db
docs: Fix typo in Fading LEDs
2014-11-03 09:42:38 +01:00
f6e825b42e
docs: Disable logo and add spacing to top index.
2014-11-02 23:45:29 +00:00
6e6dfdc56b
docs: Make custom index page; add more docs.
2014-11-02 23:37:02 +00:00
38bd762121
stmhal: Improve pyb.freq to allow 8 and 16MHz (not usable with USB).
...
Also restrict higher frequencies to have a VCO_OUT frequency below
432MHz, as specified in the datasheet.
Docs improved to list allowed frequencies, and explain about USB
stability.
2014-11-02 15:10:15 +00:00
a58713a899
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
109c1de015
py: Make gc.enable/disable just control auto-GC; alloc is still allowed.
...
gc.enable/disable are now the same as CPython: they just control whether
automatic garbage collection is enabled or not. If disabled, you can
still allocate heap memory, and initiate a manual collection.
2014-10-31 21:30:46 +00:00
4029f51842
stmhal: Fix UART so bits counts number of data bits, not incl parity.
...
Addresses issue #950 .
2014-10-31 20:28:10 +00:00
fa73c9cb25
docs: Add 2 images for tutorials.
2014-10-31 01:43:37 +00:00
88d3054ac0
docs: Import documentation from source-code inline comments.
...
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
47f349e7de
docs: Fix links to images and other parts of the docs.
2014-10-31 00:58:23 +00:00
c92ef361c7
docs: Add tutorial for fading LED using PWM, with fritzing image
2014-10-31 00:49:17 +00:00
ccedf000ed
docs: Increase size of pyboard pinout.
2014-10-26 22:58:18 +00:00
8768f8ad4b
docs: Add quick reference page, with pinout and short example code.
2014-10-26 22:11:34 +00:00
55a5b80793
docs: Make images and youtube video links work for LCD and AMP docs.
...
Images are currently served from micropython.org/static. I don't know
if there is a better way to handle images.
2014-09-25 19:42:27 +01:00
d19c256656
docs: Imported tutorials from previous documentation system.
2014-09-25 17:23:06 +01:00
6162bea5b2
docs: Initial commit of Sphinx documentation framework.
2014-09-25 17:23:06 +01:00
Damien George
Daniel Campora
Paul Sokolovsky
Radomir Dopieralski
Dave Hylands
Steve Zatz
blmorris
Henrik
Ivan Pejić
Peter Hinch
Radomir Dopieralski
Gregory
inaugurator
evildmp
Matthias
Márton Szinovszki
Shuning Bian