Damien George
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
Damien George
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
evildmp
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
Matthias
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
Paul Sokolovsky
d8474d3617
docs: select: Describe extra details.
2014-11-09 01:48:05 +02:00
Damien George
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
Damien George
0e3722137f
docs: Update front page to display date of last update.
2014-11-04 18:51:29 +00:00
Damien George
8e701604d5
docs: Add links from quickref to pyb classes.
2014-11-04 18:25:20 +00:00
Damien George
bc0bc764fc
docs: Add debounce tutorial; order Pin methods; add pull resistor info.
2014-11-04 18:07:06 +00:00
Damien George
183ac71dc8
docs: Add pdf size info to datasheet links.
2014-11-03 22:21:25 +00:00
Damien George
1e3fde0a10
docs: Add skin imgs; change external links to micropython.org/resources.
2014-11-03 22:14:23 +00:00
Damien George
72165c01f0
docs: Adjust table spacing in topindex page.
2014-11-03 20:48:43 +00:00
Márton Szinovszki
bfd11a35db
docs: Fix typo in Fading LEDs
2014-11-03 09:42:38 +01:00
Damien George
f6e825b42e
docs: Disable logo and add spacing to top index.
2014-11-02 23:45:29 +00:00
Damien George
6e6dfdc56b
docs: Make custom index page; add more docs.
2014-11-02 23:37:02 +00:00
Damien George
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
Damien George
a58713a899
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
Damien George
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
Damien George
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
Damien George
fa73c9cb25
docs: Add 2 images for tutorials.
2014-10-31 01:43:37 +00:00
Damien George
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
Damien George
47f349e7de
docs: Fix links to images and other parts of the docs.
2014-10-31 00:58:23 +00:00
Shuning Bian
c92ef361c7
docs: Add tutorial for fading LED using PWM, with fritzing image
2014-10-31 00:49:17 +00:00
Damien George
ccedf000ed
docs: Increase size of pyboard pinout.
2014-10-26 22:58:18 +00:00
Damien George
8768f8ad4b
docs: Add quick reference page, with pinout and short example code.
2014-10-26 22:11:34 +00:00
Damien George
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
Damien George
d19c256656
docs: Imported tutorials from previous documentation system.
2014-09-25 17:23:06 +01:00
Damien George
6162bea5b2
docs: Initial commit of Sphinx documentation framework.
2014-09-25 17:23:06 +01:00
