8f81beea7e
shared_bindings_matrix: Use a trivial target
...
Sommersoft noticed that without submodules (as RTD currently does),
the "make -qp" failed due to trying to find files within submodules.
The "print-VAR" target doesn't have any dependencies, so it sidesteps
the problem.
If we move ulab's pyi files into the submodule, though, we'll need to
fetch submodules anyway during doc building.
2020-05-25 13:46:30 -05:00
76149ebf57
Remove board_chip logic
...
Not sure why I moved it, the computed value is never required
2020-05-25 09:59:13 -05:00
894bb3c003
Add esp32s2, litex to SUPPORTED_PORTS, sort it
2020-05-25 09:58:57 -05:00
32de8b437c
shared_bindings_matrix: Work from parsed 'make' output
...
Revisiting this because I noticed the support matrix said that pyruler
had several modules it obviously didn't, such as the recently added
vectorio.
It is less error-prone because we can use the final values instead
of re-coding the Makefile logic in python. The only things we need
to do are invoke make in "print-database" mode, then chase any
indirect references like CIRCUITPY_VECTORIO = $(CIRCUITPY_DISPLAYIO)
It does take longer, about 45s on my laptop.
2020-05-25 09:50:24 -05:00
1d77000c19
Update doc deps
2020-05-19 10:30:47 -07:00
1e9436519b
Fix ReadTheDocs after switching to stubs + autoapi.
2020-05-18 16:29:15 -07:00
afc84c2fd1
Fix ulab, math and template.
2020-05-14 15:58:36 -07:00
4e8de3c554
Swap sphinx to autoapi and the inline stubs
2020-05-12 17:28:24 -07:00
bae7a5e433
make translate again
2020-05-04 17:26:59 -04:00
7337ea4955
fix support_matrix.py to handle ?=
2020-04-30 00:54:46 -04:00
755d404edf
Merge remote-tracking branch 'adafruit/master' into lower_power
2020-04-27 16:45:10 -07:00
8791ca6af3
implement requested changes
2020-04-23 13:33:41 -04:00
d0a2106547
Remove old build flags, add fixes for shared_matrix
2020-04-22 16:06:08 -04:00
25245bc442
Merge remote-tracking branch 'upstream/master' into stm32-docfix
2020-04-17 13:27:48 -04:00
b580b34cbf
Merge remote-tracking branch 'adafruit/master' into lower_power
2020-04-14 17:14:44 -07:00
1c45a261c4
network.rst: remove duplicate method directive
2020-04-09 08:44:35 -05:00
77562a2acd
Update the supported ports
2020-03-31 18:27:55 -07:00
7ff336fbc5
Change docs target
2020-03-11 18:50:56 -04:00
125409fe95
add proximity and sound_level
2020-03-06 13:31:08 -08:00
3c50098dfc
add stm32f4 to docs
2020-02-06 15:17:42 -05:00
ed2d94cae9
Merge pull request #2543 from pewpew-game/support-matrix
...
Fix entry overrides in support matrix generation
2020-01-21 18:18:08 -06:00
e1840f6abc
Fix entry overrides in support matrix generation
...
Fix #2539
The entries in the board's mpconfigboard.mk override any other entries.
Also, fixed a warning for bad use of backslash in a string.
2020-01-21 22:03:47 +01:00
13e0cba6f1
Add initial MIMXRT10XX port
2020-01-06 21:08:49 +01:00
cca42e94d7
Add to BUILDING to table of contents.
2019-12-14 15:00:42 -05:00
615ec7f74d
merge from upstream
2019-10-14 18:12:58 -04:00
f14fbd4aab
update docs/supported_ports.rst
2019-10-13 19:39:42 -04:00
1fa8841d20
Change port name to cxd56
2019-10-11 08:23:51 +02:00
0a48282e51
Add Spresense to supported_ports
2019-10-09 13:11:22 +02:00
01ec3b995e
use 'any()' vs 'len == 1 & == False'
2019-10-02 00:02:49 -05:00
c3dda7c535
add parsing for 'MINIMAL/DEFAULT'; process inclusion when determined by another module
2019-09-27 23:41:34 -05:00
8c75962850
add ':noindex:' to micropy's 'network.rst' to avoid sphinx conflict
2019-07-28 16:00:29 -05:00
d489c7a057
change 'c2rst' from source_parser -> extension; allows use of sphinx 2.x
2019-07-28 15:59:26 -05:00
143275db04
fix board_exclusion lookup
2019-07-27 11:01:10 -05:00
69bbdcab91
use MICROPY_HW_BOARD_NAME vice board's folder name
2019-07-27 10:30:57 -05:00
c6ac0ba683
move the support matrix to its own page; add linking for modules
2019-07-27 10:03:18 -05:00
a184380dc9
add port-wide config parsing; add modules-by-board function
2019-07-27 09:15:37 -05:00
b90b63bb2b
don't use files to pass data; call and return directly in conf.py
2019-07-23 20:49:37 -05:00
fce1efc74c
more python3.5 compatibility fixes
2019-07-07 09:14:46 -05:00
86e885c5fc
handle module exclusion when the default is to not include a module
2019-07-05 18:00:26 -05:00
7378744bb2
update regex module use to be python3.5 compatible
2019-07-05 16:11:19 -05:00
42ed84141e
fix late-night directory snafu
2019-07-04 01:49:40 -05:00
4342383d95
add jinja extension; update shared-bindings/index.rst to use jinja
2019-07-04 01:19:56 -05:00
f1256c0b35
add script to gather module support matrix info; add initial json file
2019-07-04 01:18:16 -05:00
48443c9c3f
Update import statement in code snippet.
...
The code snippets in the Design Guide article reference without the statement.
2019-06-25 08:36:44 -04:00
0bb92d4fc3
Fix references to cpython in builtins documentation.
2019-06-18 16:59:05 -05:00
99164a9a13
Pin dependencies to force sphinx 1.8.5
2019-05-11 21:24:39 -07:00
63c720bcfb
Include sphinx and recommonmark in docs/requirements.txt
2019-05-11 19:58:10 -07:00
5f5e456e58
Tweak RTD to install svg2pdfconverter
2019-04-17 18:22:19 -07:00
a9e2592425
add weight sensor property to the design guide
2019-03-25 18:10:15 -04:00
c80e22b6fc
make less vaguer
2019-02-15 18:12:58 -06:00
156b0d286a
dropped the fancy URLs so Sphinx doesn't complain
2019-02-14 23:32:41 -06:00
12ccd5ec55
link to new drivers.rst on the Bundle
2019-02-14 20:45:46 -06:00
3e25d611ef
all: Bump version to 1.10.
2019-01-26 00:56:48 +11:00
acd647100b
docs/library: Add documentation for esp32 module.
2019-01-25 12:18:34 +11:00
69e72954ad
docs: Add initial docs for esp32 port, including quick-ref and general.
...
With contributions from Oliver Robson (@HowManyOliversAreThere), Sean
Lanigan (@seanlano) and @rprr.
2019-01-25 12:18:34 +11:00
04aa906fac
fix a few ble-related doc issues
2019-01-24 00:13:15 -05:00
ffe734edf7
Fresh combined checkin of _pixelbuf library.
2019-01-13 23:51:13 -05:00
5064df2074
docs/differences: Clarify the differences are against Python 3.4.
2019-01-11 12:11:02 +11:00
4167bf5b24
wip: advertising works, but not connection
2018-12-27 00:04:04 -05:00
169b152f29
docs/ure: Fully describe supported syntax subset, add example.
2018-12-13 01:16:30 +11:00
beeeec292b
docs/README: Remove references to MICROPY_PORT when building docs.
...
The docs are now built as one for all ports.
2018-12-11 02:55:22 +11:00
4254ae6d5b
add 74HC595
2018-11-21 13:05:02 -06:00
59430ea26d
fix L3GD20 link
2018-11-21 12:58:11 -06:00
d7aa790e4b
add trailing '/' to links missing them
2018-11-21 12:55:01 -06:00
e2bfe91700
i have no more words...
2018-11-13 23:37:27 -06:00
c669f7563c
git diff review fail before push...
2018-11-13 23:32:50 -06:00
a7a66e9399
fix led-animation url; it has 2 valid urls...
2018-11-13 23:28:23 -06:00
b68517fbab
replaced scrubbed drivers
2018-11-13 23:24:53 -06:00
028915d6f7
update /docs/drivers.rst page; 19 drivers added
2018-11-13 19:45:11 -06:00
42d0a28117
docs/conf.py: Use https for intersphinx link to docs.python.org.
...
To get rid of warning when building the docs saying there's a redirect from
http: to https:.
2018-10-23 11:47:35 +11:00
dd76c8dc0f
docs/library/uctypes: Add examples and make general updates.
...
Examples are added to the beginning of the module docs, similarly to docs
for many other modules.
Improvements to grammar, style, and clarity. Some paragraphs are updated
with better suggestions. A warning added of the effect incorrect usage of
the module may have. Describe the fact that offset range used in one
defined structure is limited.
2018-10-23 11:42:30 +11:00
b031b6f4dd
docs/pyb.Pin: Minor typo fix to specify Pin in pyb.Pin.cpu.
2018-10-19 17:31:59 +11:00
5f7088f84d
docs/uio: Document StringIO/BytesIO(alloc_size) constructors.
2018-10-18 12:39:25 +11:00
759853f2a1
docs/machine.Pin: Document "hard" argument of Pin.irq method.
2018-10-15 00:17:54 +11:00
7de9211b80
docs/machine.Pin: Add note regarding irq handler argument.
2018-10-13 16:25:42 +11:00
f5d46a88aa
lib/utils/pyexec: Forcefully unlock the heap if locked and REPL active.
...
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-13 16:21:08 +11:00
5bb12793a0
update documentation and translations again
2018-10-11 22:19:46 +11:00
d251f26688
docs/uselect: Describe more aspects of poll.register/modify behavior.
...
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-05 16:57:58 +10:00
86819a52fe
docs/wipy: Fix links to network.Server, and markup for boot.py.
2018-10-01 14:08:02 +10:00
d1adfee251
docs: Remove sphinx_selective_exclude, it's no longer used.
2018-10-01 13:54:32 +10:00
b3e013f60e
docs: Unify all the ports into one set of documentation.
...
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-10-01 13:53:53 +10:00
8a84e08dc8
docs/library/network: Make AbstractNIC methods layout correctly.
2018-09-27 17:24:41 +10:00
217566b764
docs/library/network: Move specific network classes to their own file.
...
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-27 17:23:42 +10:00
09c5c58a1f
docs/library/machine.SPI: Add note about baudrate imprecision.
2018-09-26 15:21:10 +10:00
ad4fb62f13
docs/pyboard: Fix to use Sphinx style for internal/external links.
2018-09-20 17:14:13 +10:00
927a5d1dfd
docs/library/pyb: Add deprecation warning for mount and old block proto.
...
pyb.mount(None, mountpoint) functionality is also removed and replaced by
uos.umount.
2018-09-20 16:31:36 +10:00
12e2a26406
Add new drivers to the doc page
2018-09-07 15:19:37 -07:00
b18fa1e606
docs/library/machine.UART.rst: Specify optional txbuf and rxbuf args.
...
If a port would like to expose the configuration of transmit and/or receive
buffers then it can use these arguments.
2018-08-14 15:21:54 +10:00
163bacd1e8
docs/library/machine.I2C.rst: Clarify availability of primitive I2C ops.
2018-08-04 15:53:12 +10:00
d8e0320485
docs: Move WiPy specific Timer class to separate doc file.
...
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-31 23:40:06 +10: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
81e320aecc
docs/library/machine: Remove conditionals in machine class index.
...
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-20 15:58:18 +10:00
0ab8428995
docs/reference/index: Remove conditional for inline asm docs.
...
The heading of this section makes it clear it is for Thumb-2 architectures
only.
2018-07-20 15:51:06 +10:00
5b1ca66668
docs/library/index: Add hint about using help('modules') for discovery.
2018-07-20 15:47:42 +10:00
84d5dd46fe
docs/library/index: Remove all conditionals from library index.
...
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-20 15:34:22 +10:00
3e0d587a49
docs/library/machine: Remove conditional docs for rng function.
...
And instead list its availability explicitly.
2018-07-18 16:28:30 +10:00
163cc66a0b
docs/library/machine: Remove conditional docs for wake_reason function.
...
And instead list its availability explicitly.
2018-07-18 16:23:34 +10:00
Jeff Epler
Scott Shawcroft
Dan Halbert
Lucian Copeland
sommersoft
caternuson
sommersoft
Radomir Dopieralski
arturo182
Roy Hooper
Kamil Tomaszewski
Alexander Hagerman
Craig Forbes
John Reese
brentru
Damien George
Matt Trentini
stijn
Paul Sokolovsky
Dave Hylands
Peter Hinch
Nick Moore
Scott Shawcroft