Skip to content

Commit 7895cac

Browse files
committed
index: Simplify landing.
Docs are great if you know what to look for already. Otherwise it is better to start in the welcome guide.
1 parent b891f6c commit 7895cac

2 files changed

Lines changed: 19 additions & 164 deletions

File tree

doc/main/blocks/index.rst

Lines changed: 0 additions & 148 deletions
This file was deleted.

doc/main/index.rst

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,38 @@
1-
Pybricks Documentation
1+
Pybricks Reference Manual
22
==================================================================
33

4-
`Pybricks <https://pybricks.com/>`_ is Python coding for smart LEGO® hubs.
5-
Run MicroPython scripts
6-
directly on the hub, and get full control of your motors and sensors.
4+
.. only:: ide
75

8-
Pybricks runs on LEGO® BOOST, City, Technic, MINDSTORMS®, and SPIKE®. You
9-
can code using Windows, Mac, Linux, Chromebook, and Android.
6+
This documentation details all available functions and classes in Pybricks.
7+
For example, you can find the meaning of specific function parameters like
8+
motor speed.
109

11-
Click on any device below to see its documentation. Use the menu on the left
12-
to find documentation for additional modules. You may need to click the ☰ icon
13-
above to reveal this menu.
10+
If you are new to Pybricks, we recommend starting with the `Pybricks learn`_
11+
guide instead.
1412

1513
.. only:: main
1614

15+
`Pybricks <https://pybricks.com/>`_ is Python coding for smart LEGO® hubs.
16+
Run MicroPython scripts
17+
directly on the hub, and get full control of your motors and sensors.
18+
19+
Pybricks runs on LEGO® BOOST, City, Technic, MINDSTORMS®, and SPIKE®. You
20+
can code using Windows, Mac, Linux, Chromebook, and Android.
21+
1722
.. note:: You are viewing the stand-alone version of the documentation. To
1823
learn more about Pybricks and to start coding, visit
1924
the `Pybricks website`_
2025

2126
.. note:: Are you using LEGO MINDSTORMS EV3? Check out the
2227
`EV3 documentation`_ instead.
2328

29+
Click on any device below to see its documentation. Use the menu on the left
30+
to find documentation for additional modules. You may need to click the ☰ icon
31+
above to reveal this menu.
32+
2433
.. _EV3 documentation: https://pybricks.com/ev3-micropython/
2534
.. _Pybricks website: https://pybricks.com/
35+
.. _Pybricks learn: https://pybricks.com/learn/
2636

2737
.. rubric:: Programmable hubs
2838

@@ -63,13 +73,6 @@ above to reveal this menu.
6373
messaging/index
6474
signaltypes
6575

66-
.. toctree::
67-
:maxdepth: 1
68-
:caption: Code with blocks
69-
:hidden:
70-
71-
blocks/index
72-
7376
.. toctree::
7477
:maxdepth: 1
7578
:caption: MicroPython modules

0 commit comments

Comments
 (0)