Commit Graph

936 Commits

Author SHA1 Message Date
sommersoft
ffffccf7a0 docs/rstjinja.py: add jinja processing for building latex (pdf) docs 2020-08-15 14:29:09 -05:00
Taku Fukada
56c898da80 Modify some Python stubs 2020-08-07 01:01:28 +09:00
Taku Fukada
887eb3b6d9 Apply a Sphinx transform to make the core module docs look better 2020-08-07 00:01:31 +09:00
Scott Shawcroft
efee11dffe
Add black too 2020-07-28 11:42:58 -07:00
Scott Shawcroft
01cd1c5b34
add isort to doc deps
Fixes #3200
2020-07-27 18:42:53 -07:00
Diego Elio Pettenò
34b4993d63 Add license to some obvious files. 2020-07-06 19:16:25 +01:00
Tyler Crumpton
d1c9bb30e2
Fix minor typo in MicroPython libraries page 2020-07-06 09:56:52 -05:00
Scott Shawcroft
eec42d4cb5
Merge pull request #3087 from sommersoft/cpy_org_sptmtrx
Release PRs To circuitpython.org: Include The Available Built-in Modules For Each Board
2020-07-02 13:45:39 -07:00
Scott Shawcroft
7750eb0dcc
Merge pull request #3082 from sommersoft/customcss_old_docs_warning
[main] Custom CSS For "Viewing Outdated Docs" Message
2020-06-29 15:52:46 -07:00
sommersoft
c84c30846c docs/shared_bindings_matrix.py: use '__file__' to ascertain root dir 2020-06-29 09:02:04 -05:00
sommersoft
d911dc98d9 docs/shared_binding_matrix.py: fix usage with the branded name (building docs) 2020-06-29 01:09:04 -05:00
sommersoft
87e4f47866 docs/shared_bindings_matrix.py: changes to allow usage in 'tools/build_board_info.py'; includes root dir finder, and output board name option. 2020-06-29 00:17:12 -05:00
sommersoft
ba0911b0f6 add custom css for 'viewing-old-docs' message 2020-06-26 17:01:25 -05:00
Jeff Epler
844f575a90 redirects: Add __init__ page redirects 2020-06-26 15:06:22 -05:00
Jeff Epler
2019d47ed5 redirects.txt: sort according to LANG=C.UTF-8 collation rules 2020-06-26 15:05:57 -05:00
Jeff Epler
e7923c068e docs: Explain our shift in terminology 2020-06-25 11:44:21 -05:00
Jeff Epler
1d2cc0b968 I2CPeripheral: Rename class and its module
This is an incompatible change.
2020-06-25 11:44:19 -05:00
Jeff Epler
ce95b9379d Refer to "main" branch of circuitpython 2020-06-25 11:42:23 -05:00
Jeff Epler
cb8539b06d docs: Generate redirects for autoapi renaming 2020-06-14 13:04:21 -05:00
Diego Elio Pettenò
dd5d7c86d2 Fix up end of file and trailing whitespace.
This can be enforced by pre-commit, but correct it separately to make it easier to review.
2020-06-03 10:56:35 +01:00
Jeff Epler
9966bf86da shared_bindings_matrix: sommersoft's suggestions 2020-05-26 09:55:23 -05:00
Jeff Epler
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
Jeff Epler
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
Jeff Epler
894bb3c003 Add esp32s2, litex to SUPPORTED_PORTS, sort it 2020-05-25 09:58:57 -05:00
Jeff Epler
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
Scott Shawcroft
1d77000c19
Update doc deps 2020-05-19 10:30:47 -07:00
Scott Shawcroft
1e9436519b
Fix ReadTheDocs after switching to stubs + autoapi. 2020-05-18 16:29:15 -07:00
Scott Shawcroft
afc84c2fd1
Fix ulab, math and template. 2020-05-14 15:58:36 -07:00
Scott Shawcroft
4e8de3c554
Swap sphinx to autoapi and the inline stubs 2020-05-12 17:28:24 -07:00
Dan Halbert
bae7a5e433 make translate again 2020-05-04 17:26:59 -04:00
Dan Halbert
7337ea4955 fix support_matrix.py to handle ?= 2020-04-30 00:54:46 -04:00
Scott Shawcroft
755d404edf
Merge remote-tracking branch 'adafruit/master' into lower_power 2020-04-27 16:45:10 -07:00
Lucian Copeland
8791ca6af3 implement requested changes 2020-04-23 13:33:41 -04:00
Lucian Copeland
d0a2106547 Remove old build flags, add fixes for shared_matrix 2020-04-22 16:06:08 -04:00
Lucian Copeland
25245bc442 Merge remote-tracking branch 'upstream/master' into stm32-docfix 2020-04-17 13:27:48 -04:00
Scott Shawcroft
b580b34cbf
Merge remote-tracking branch 'adafruit/master' into lower_power 2020-04-14 17:14:44 -07:00
sommersoft
1c45a261c4 network.rst: remove duplicate method directive 2020-04-09 08:44:35 -05:00
Scott Shawcroft
77562a2acd
Update the supported ports 2020-03-31 18:27:55 -07:00
Lucian Copeland
7ff336fbc5 Change docs target 2020-03-11 18:50:56 -04:00
caternuson
125409fe95 add proximity and sound_level 2020-03-06 13:31:08 -08:00
Lucian Copeland
3c50098dfc add stm32f4 to docs 2020-02-06 15:17:42 -05:00
sommersoft
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
Radomir Dopieralski
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
arturo182
13e0cba6f1 Add initial MIMXRT10XX port 2020-01-06 21:08:49 +01:00
Roy Hooper
cca42e94d7 Add to BUILDING to table of contents. 2019-12-14 15:00:42 -05:00
Dan Halbert
615ec7f74d merge from upstream 2019-10-14 18:12:58 -04:00
Dan Halbert
f14fbd4aab update docs/supported_ports.rst 2019-10-13 19:39:42 -04:00
Kamil Tomaszewski
1fa8841d20 Change port name to cxd56 2019-10-11 08:23:51 +02:00
Kamil Tomaszewski
0a48282e51 Add Spresense to supported_ports 2019-10-09 13:11:22 +02:00
sommersoft
01ec3b995e use 'any()' vs 'len == 1 & == False' 2019-10-02 00:02:49 -05:00
sommersoft
c3dda7c535 add parsing for 'MINIMAL/DEFAULT'; process inclusion when determined by another module 2019-09-27 23:41:34 -05:00
sommersoft
8c75962850 add ':noindex:' to micropy's 'network.rst' to avoid sphinx conflict 2019-07-28 16:00:29 -05:00
sommersoft
d489c7a057 change 'c2rst' from source_parser -> extension; allows use of sphinx 2.x 2019-07-28 15:59:26 -05:00
sommersoft
143275db04 fix board_exclusion lookup 2019-07-27 11:01:10 -05:00
sommersoft
69bbdcab91 use MICROPY_HW_BOARD_NAME vice board's folder name 2019-07-27 10:30:57 -05:00
sommersoft
c6ac0ba683 move the support matrix to its own page; add linking for modules 2019-07-27 10:03:18 -05:00
sommersoft
a184380dc9 add port-wide config parsing; add modules-by-board function 2019-07-27 09:15:37 -05:00
sommersoft
b90b63bb2b don't use files to pass data; call and return directly in conf.py 2019-07-23 20:49:37 -05:00
sommersoft
fce1efc74c more python3.5 compatibility fixes 2019-07-07 09:14:46 -05:00
sommersoft
86e885c5fc handle module exclusion when the default is to not include a module 2019-07-05 18:00:26 -05:00
sommersoft
7378744bb2 update regex module use to be python3.5 compatible 2019-07-05 16:11:19 -05:00
sommersoft
42ed84141e fix late-night directory snafu 2019-07-04 01:49:40 -05:00
sommersoft
4342383d95 add jinja extension; update shared-bindings/index.rst to use jinja 2019-07-04 01:19:56 -05:00
sommersoft
f1256c0b35 add script to gather module support matrix info; add initial json file 2019-07-04 01:18:16 -05:00
Alexander Hagerman
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
Craig Forbes
0bb92d4fc3 Fix references to cpython in builtins documentation. 2019-06-18 16:59:05 -05:00
John Reese
99164a9a13 Pin dependencies to force sphinx 1.8.5 2019-05-11 21:24:39 -07:00
John Reese
63c720bcfb Include sphinx and recommonmark in docs/requirements.txt 2019-05-11 19:58:10 -07:00
Scott Shawcroft
5f5e456e58
Tweak RTD to install svg2pdfconverter 2019-04-17 18:22:19 -07:00
brentru
a9e2592425 add weight sensor property to the design guide 2019-03-25 18:10:15 -04:00
sommersoft
c80e22b6fc
make less vaguer 2019-02-15 18:12:58 -06:00
sommersoft
156b0d286a
dropped the fancy URLs so Sphinx doesn't complain 2019-02-14 23:32:41 -06:00
sommersoft
12ccd5ec55
link to new drivers.rst on the Bundle 2019-02-14 20:45:46 -06:00
Damien George
3e25d611ef all: Bump version to 1.10. 2019-01-26 00:56:48 +11:00
Damien George
acd647100b docs/library: Add documentation for esp32 module. 2019-01-25 12:18:34 +11:00
Matt Trentini
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
Dan Halbert
04aa906fac fix a few ble-related doc issues 2019-01-24 00:13:15 -05:00
Roy Hooper
ffe734edf7 Fresh combined checkin of _pixelbuf library. 2019-01-13 23:51:13 -05:00
stijn
5064df2074 docs/differences: Clarify the differences are against Python 3.4. 2019-01-11 12:11:02 +11:00
Dan Halbert
4167bf5b24 wip: advertising works, but not connection 2018-12-27 00:04:04 -05:00
Paul Sokolovsky
169b152f29 docs/ure: Fully describe supported syntax subset, add example. 2018-12-13 01:16:30 +11:00
Damien George
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
sommersoft
4254ae6d5b add 74HC595 2018-11-21 13:05:02 -06:00
sommersoft
59430ea26d fix L3GD20 link 2018-11-21 12:58:11 -06:00
sommersoft
d7aa790e4b add trailing '/' to links missing them 2018-11-21 12:55:01 -06:00
sommersoft
e2bfe91700 i have no more words... 2018-11-13 23:37:27 -06:00
sommersoft
c669f7563c git diff review fail before push... 2018-11-13 23:32:50 -06:00
sommersoft
a7a66e9399 fix led-animation url; it has 2 valid urls... 2018-11-13 23:28:23 -06:00
sommersoft
b68517fbab replaced scrubbed drivers 2018-11-13 23:24:53 -06:00
sommersoft
028915d6f7 update /docs/drivers.rst page; 19 drivers added 2018-11-13 19:45:11 -06:00
Paul Sokolovsky
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
Paul Sokolovsky
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
Dave Hylands
b031b6f4dd docs/pyb.Pin: Minor typo fix to specify Pin in pyb.Pin.cpu. 2018-10-19 17:31:59 +11:00
Paul Sokolovsky
5f7088f84d docs/uio: Document StringIO/BytesIO(alloc_size) constructors. 2018-10-18 12:39:25 +11:00
Peter Hinch
759853f2a1 docs/machine.Pin: Document "hard" argument of Pin.irq method. 2018-10-15 00:17:54 +11:00
Peter Hinch
7de9211b80 docs/machine.Pin: Add note regarding irq handler argument. 2018-10-13 16:25:42 +11:00
Damien George
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
Nick Moore
5bb12793a0 update documentation and translations again 2018-10-11 22:19:46 +11:00
Paul Sokolovsky
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
Damien George
86819a52fe docs/wipy: Fix links to network.Server, and markup for boot.py. 2018-10-01 14:08:02 +10:00