Commit Graph
21 Commits
Author SHA1 Message Date
Laurens Valk 9c8d41efb8 doc/index: Update install note in IDE docs. 2021-04-09 12:21:47 +02:00
Laurens Valk a06e01c6de doc/start_pup/ev3: Drop installation guide.
These are now at https://pybricks.com/install/
2021-04-07 19:56:56 +02:00
Laurens Valk c46b249c8c @pybricks/ide-docs v1.1.1 2021-02-14 19:32:52 +01:00
Laurens Valk 67008b67d8 doc/ide: include installation guide 2021-02-14 19:26:10 +01:00
Laurens Valk 9c1beef6b6 doc/parameters/Port: move doc to rst 2021-02-14 19:00:52 +01:00
Laurens Valk 632908f59a doc/parameters: split out page per class 2021-02-14 16:06:23 +01:00
Laurens Valk 4a7fa12eaa config: add classlink directive
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.
2021-02-14 15:39:39 +01:00
David Lechner deb211bdb7 @pybricks/ide-docs v1.1.0 2021-01-28 12:31:19 -06:00
David Lechner b4c8242133 doc/ide: add node package
This will be used to publish the docs in a way that is easy for
pybricks-code to use.
2021-01-26 08:30:48 +01:00
David Lechner 06e01e5ac8 doc/ide: use sphinx.ext.imgmath
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.
2021-01-26 08:30:48 +01:00
David Lechner 7d729a8e9e doc/ide: hide the "view source" link
Since these are meant to be offline docs and use a smaller screen area
we can omit this to keep things cleaner.
2021-01-26 08:30:48 +01:00
David Lechner c750a3cd88 doc/ide: hide prev/next buttons
In the IDE this is more of a reference and less of a book so going to
the next page doesn't make as much sense.
2021-01-26 08:30:48 +01:00
David Lechner 7abb670f66 doc/ide: hide footers
This information is duplicated in the IDE about dialog so we don't need
it in the docs.
2021-01-26 08:30:48 +01:00
Laurens Valk bb77e0f413 doc/hubs: link inventorhub to primehub 2021-01-19 11:45:14 +01:00
Laurens Valk c5851a3569 doc/ide: add landing page images 2021-01-19 11:42:21 +01:00
Laurens Valk 7d40e07dfb doc/hubs: InventorHub and PrimeHub on same page
Make it a bit more explicit that they are the same.
2021-01-19 11:18:21 +01:00
Laurens Valk 5ab71de988 doc/ide: improve landing page
Add visuals to quickly get to hubs or pupdevices. These still need to be made into smaller more generic images, but these will do for now.
2021-01-18 16:34:10 +01:00
Laurens Valk d7254472f0 doc/ide: simplify landing page and menu
The embedded docs will only have the module documentation. Remove everything else.
2021-01-18 16:33:14 +01:00
Laurens Valk 31891d0970 doc/ide: Drop EV3 pages 2021-01-18 16:33:14 +01:00
Laurens Valk db4cbe66c1 all: update copyright year 2021-01-18 14:34:28 +01:00
Laurens Valk 087dab5ed1 doc/ide: add build target for Pybricks Code
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.
2021-01-18 12:50:27 +01:00