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.
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.
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.
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.
We have index pages for most modules now, which link to individual classes. It is helpful if these empty class headers are hyperlinks. This commit does just that.
For most sensors/devices so far this is not really necessary as the images are already hyperlinks. But this will become more useful as we start adding index pages like these for classes without images, such as parameters.
MathJax uses a CDN to to distribute the package. So in order to use the
docs offline, we would have to include our own copy. But it is a bit
large (50-ish MB), so it is easier to use sphinx.ext.imgmath instead
to generate svg images.
The situation might be different with MathJax v3, but that requires
Sphinx v4.
poetry run make -C doc SOURCEDIR=ide html
This adds a build target for docs to integrate in Pybricks Code. This commit makes the build target produce an identical copy, by making each page reference its original rst file.
Now we can easily exclude certain components (such as EV3) as needed for Pybricks Code, and also change the main index / welcome page.
Laurens Valk
David Lechner