mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-12 01:24:17 +00:00
Laurens Valk
fbd843cb54
The `only` directive can be used to include content selectively. It cannot be used to select a different TOC, which is why we resorted to separate doc builds before. Now that we have dropped EV3 references from the docs, we can use a single build and just customize the content on the landing page with the only directive. The docs can now be built with: # Main docs: make -C doc html SPHINXOPTS=-tmain # IDE docs: make -C doc html SPHINXOPTS=-tide
Pybricks end-user API & Documentation ===================================== This repository documents the Pybricks end-user MicroPython API. Each `Pybricks firmware`_ comes with the `Pybricks package`_. All modules, classes, methods, and functions in that package have optimized implementations in C for high performance and reduced memory footprint. This repository provides an empty, pure Python blueprint of that package. It is used to generate the `official documentation`_. See the `contributor's guide <CONTRIBUTING.md>`_ for acceptable changes and instructions to build the documentation locally. For general discussion, please visit the `support`_ issue tracker. .. _Pybricks package: pybricks .. _Pybricks firmware: https://github.com/pybricks/pybricks-micropython .. _official documentation: https://docs.pybricks.com/ .. _support: https://github.com/pybricks/support/issues