List all functions and classes explicitly so we can organize them by category in later commits.
Also split out exceptions and uerrno to dedicated page because the builtins page was getting very long and hard to navigate.
This merges the useful information from two different places:
- The original docstring for const.
- Writing MicroPython code for constrained devices.
Also reduce type to just int, because only ints are supported.
TConst does not exist, so adding it makes it a bit harder to read than needed. The const() "function" will take int or float, and the return value can be used as such, even if it is optimized out. This is described in the docstring, so we can leave out the additional type.
Also adds autofunctions in place of one auto module so we can move things around as needed. Also fix cross links with usys to get the build to pass before we update that module.
The doc/api is a legacy name, which is confusing in the current use, since all build targets are now APIs.
Today we have:
doc/common: Common configuration and settings between all targets.
doc/main: Main Pybricks documentation at docs.pybricks.com.
doc/ide: Documentation shipped with the Pybricks Code IDE.
There is no ubuiltins module, so we shouldn't mention it.
Also reduce size of other module titles so they fit on one line in the
menu. This makes it easier to read and get an overview.
These were hidden for the 3.0 release, but we can re-enable them for
the beta release of 3.1.
Revert "v3: Drop parameters Side and Button."
This reverts commit 07c53e9a3d.
Revert "v3: Drop Remote control."
This reverts commit b600f5029e.
Revert "v3: Drop geometry module."
This reverts commit 5f767f3fee.
Revert "v3: Drop Prime Hub and Inventor Hub."
This reverts commit 8db7892f8c.
Revert "v3: Drop IMU documentation."
This reverts commit b325bf4bff.
Sphinx changed how filenames are generated which broke media playback.
The file name now includes the MD5 hash of the filename passed to the
:download: directive.
This was done with the following script:
for f in $(find media/ev3dev-media/ -name "*.wav" -exec bash -c 'echo "$(echo -n ../../'{}' | md5sum)/$(basename '{}')"' \;); do
sed -i "s,_downloads/$(basename $f),_downloads/$f," doc/api/media.rst;
done
On the web, we want to be able to navigate between the various Pybricks
subdomains without opening new tabs. But Pybricks Code is treated as an
"app", we don't want links to open in Pybricks Code.
Laurens Valk
David Lechner