doc/main: Rename from doc/api.

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.
2026-07-27 19:57:02 +00:00 · 2021-07-14 11:39:20 +02:00
parent 55aec445b1
commit 238204d280
268 changed files with 128 additions and 128 deletions
@@ -6,7 +6,7 @@
    "python.linting.enabled": true,
    "python.languageServer": "Pylance",
    "files.associations": {"*.inc": "restructuredtext"},
-    "restructuredtext.confPath": "${workspaceFolder}/doc/api",
+    "restructuredtext.confPath": "${workspaceFolder}/doc/main",
    "spellright.language": [
        "en_US"
    ],
@@ -62,15 +62,15 @@ Build docs:

    # Linux
    poetry run make -C doc html
-    xdg-open doc/api/build/html/index.html
+    xdg-open doc/main/build/html/index.html

    # macOS
    poetry run make -C doc html
-    open doc/api/build/html/index.html
+    open doc/main/build/html/index.html

    # Windows (PowerShell)
    poetry run doc\make.bat html
-    Invoke-Item doc\api\build\html\index.html
+    Invoke-Item doc\main\build\html\index.html

 Linting:

@@ -5,7 +5,7 @@
 SPHINXOPTS    = -W
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = Pybricks
-SOURCEDIR     = api
+SOURCEDIR     = main
 BUILDDIR      = "$(SOURCEDIR)"/build

 # Put it first so that "make" without argument is like "make help".
@@ -1 +1 @@
-.. include:: ../api/geometry.rst
+.. include:: ../main/geometry.rst
@@ -1 +1 @@
-.. include:: ../../api/hubs/cityhub.rst
+.. include:: ../../main/hubs/cityhub.rst
@@ -14,30 +14,30 @@

 .. pybricks-classlink:: MoveHub

-.. figure:: ../../api/images/movehub.png
+.. figure:: ../../main/images/movehub.png
    :height: 10 em
    :target: movehub.html

 .. pybricks-classlink:: CityHub

-.. figure:: ../../api/images/cityhub.png
+.. figure:: ../../main/images/cityhub.png
    :height: 10 em
    :target: cityhub.html

 .. pybricks-classlink:: TechnicHub

-.. figure:: ../../api/images/technichub.png
+.. figure:: ../../main/images/technichub.png
    :height: 10 em
    :target: technichub.html

 .. pybricks-classlink:: PrimeHub

-.. figure:: ../../api/images/primehub.png
+.. figure:: ../../main/images/primehub.png
    :height: 10 em
    :target: primehub.html

 .. pybricks-classlink:: InventorHub

-.. figure:: ../../api/images/inventorhub.png
+.. figure:: ../../main/images/inventorhub.png
    :height: 10 em
    :target: primehub.html
@@ -1 +1 @@
-.. include:: ../../api/hubs/movehub.rst
+.. include:: ../../main/hubs/movehub.rst
@@ -1 +1 @@
-.. include:: ../../api/hubs/primehub.rst
+.. include:: ../../main/hubs/primehub.rst
@@ -1 +1 @@
-.. include:: ../../api/hubs/technichub.rst
+.. include:: ../../main/hubs/technichub.rst
@@ -56,13 +56,13 @@ commonly used devices and classes are listed below for quick reference.

 .. rubric:: Programmable Hubs

-.. figure:: ../api/images/hubsoverview.png
+.. figure:: ../main/images/hubsoverview.png
   :width: 100 %
   :target: hubs/index.html

 .. rubric:: Powered Up Motors and Sensors

-.. figure:: ../api/images/pupdevicesoverview.png
+.. figure:: ../main/images/pupdevicesoverview.png
   :width: 100 %
   :target: pupdevices/index.html

@@ -12,6 +12,6 @@

 .. pybricks-classlink:: PUPDevice

-.. figure:: ../../api/images/sensor_pup.png
+.. figure:: ../../main/images/sensor_pup.png
   :width: 70 %
   :target: pupdevice.html
@@ -1 +1 @@
-.. include:: ../../api/iodevices/pupdevice.rst
+.. include:: ../../main/iodevices/pupdevice.rst
@@ -1 +1 @@
-.. include:: ../../api/micropython/index.rst
+.. include:: ../../main/micropython/index.rst
@@ -1 +1 @@
-.. include:: ../../api/micropython/micropython.rst
+.. include:: ../../main/micropython/micropython.rst
@@ -1 +1 @@
-.. include:: ../../api/micropython/uerrno.rst
+.. include:: ../../main/micropython/uerrno.rst
@@ -1 +1 @@
-.. include:: ../../api/micropython/uio.rst
+.. include:: ../../main/micropython/uio.rst
@@ -1 +1 @@
-.. include:: ../../api/micropython/umath.rst
+.. include:: ../../main/micropython/umath.rst
@@ -1 +1 @@
-.. include:: ../../api/micropython/urandom.rst
+.. include:: ../../main/micropython/urandom.rst
@@ -1 +1 @@
-.. include:: ../../api/micropython/uselect.rst
+.. include:: ../../main/micropython/uselect.rst
@@ -1 +1 @@
-.. include:: ../../api/micropython/usys.rst
+.. include:: ../../main/micropython/usys.rst
@@ -1 +1 @@
-.. include:: ../api/motors.rst
+.. include:: ../main/motors.rst
@@ -1 +1 @@
-.. include:: ../../api/parameters/button.rst
+.. include:: ../../main/parameters/button.rst
@@ -1 +1 @@
-.. include:: ../../api/parameters/color.rst
+.. include:: ../../main/parameters/color.rst
@@ -1 +1 @@
-.. include:: ../../api/parameters/direction.rst
+.. include:: ../../main/parameters/direction.rst
@@ -1 +1 @@
-.. include:: ../../api/parameters/index.rst
+.. include:: ../../main/parameters/index.rst
@@ -1 +1 @@
-.. include:: ../../api/parameters/side.rst
+.. include:: ../../main/parameters/side.rst
@@ -1 +1 @@
-.. include:: ../../api/parameters/stop.rst
+.. include:: ../../main/parameters/stop.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/colordistancesensor.rst
+.. include:: ../../main/pupdevices/colordistancesensor.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/colorsensor.rst
+.. include:: ../../main/pupdevices/colorsensor.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/dcmotor.rst
+.. include:: ../../main/pupdevices/dcmotor.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/forcesensor.rst
+.. include:: ../../main/pupdevices/forcesensor.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/index.rst
+.. include:: ../../main/pupdevices/index.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/infraredsensor.rst
+.. include:: ../../main/pupdevices/infraredsensor.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/light.rst
+.. include:: ../../main/pupdevices/light.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/motor.rst
+.. include:: ../../main/pupdevices/motor.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/pfmotor.rst
+.. include:: ../../main/pupdevices/pfmotor.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/remote.rst
+.. include:: ../../main/pupdevices/remote.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/tiltsensor.rst
+.. include:: ../../main/pupdevices/tiltsensor.rst
@@ -1 +1 @@
-.. include:: ../../api/pupdevices/ultrasonicsensor.rst
+.. include:: ../../main/pupdevices/ultrasonicsensor.rst
@@ -1 +1 @@
-.. include:: ../api/robotics.rst
+.. include:: ../main/robotics.rst
@@ -1 +1 @@
-.. include:: ../api/signaltypes.rst
+.. include:: ../main/signaltypes.rst
@@ -1 +1 @@
-.. include:: ../../api/tools/index.rst
+.. include:: ../../main/tools/index.rst
--- a/Show More
+++ b/Show More