Skip to content

Commit

Permalink
doc/main/index: Clarify categories.
Browse files Browse the repository at this point in the history
This is more descriptive than just repeating the module name.
  • Loading branch information
laurensvalk committed Dec 16, 2022
1 parent 98e7d81 commit 1c5e390
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 9 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

## Unreleased

### Changed
- Changed module TOC headings to make it easier to find things.

## 3.2.0c1 - 2022-12-09

### Changed
Expand Down
4 changes: 2 additions & 2 deletions doc/main/hubs/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. pybricks-requirements::

:mod:`hubs <pybricks.hubs>` -- Programmable hubs
================================================
:mod:`hubs <pybricks.hubs>` -- Built-in hub functions
=====================================================

.. module:: pybricks.hubs

Expand Down
4 changes: 2 additions & 2 deletions doc/main/iodevices/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. pybricks-requirements:: pybricks-iodevices

:mod:`iodevices <pybricks.iodevices>` -- Generic I/O devices
:mod:`iodevices <pybricks.iodevices>` -- Custom devices
============================================================

.. module:: pybricks.iodevices
Expand All @@ -12,7 +12,7 @@
pupdevice
lwp3device

This module has classes for generic input/output devices.
This module has classes for generic and custom input/output devices.

.. pybricks-classlink:: PUPDevice

Expand Down
4 changes: 2 additions & 2 deletions doc/main/pupdevices/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. pybricks-requirements::

:mod:`pupdevices <pybricks.pupdevices>` -- Powered Up devices
=============================================================
:mod:`pupdevices <pybricks.pupdevices>` -- Motors, sensors, lights
==================================================================

.. automodule:: pybricks.pupdevices
:no-members:
Expand Down
4 changes: 2 additions & 2 deletions doc/main/robotics.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. pybricks-requirements::

:mod:`robotics <pybricks.robotics>` -- Robotics
======================================================
:mod:`robotics <pybricks.robotics>` -- Robotics and drive bases
===============================================================

.. automodule:: pybricks.robotics
:no-members:
Expand Down
2 changes: 1 addition & 1 deletion doc/main/tools/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. pybricks-requirements::

:mod:`tools <pybricks.tools>` -- General purpose tools
:mod:`tools <pybricks.tools>` -- Timing tools
========================================================

.. automodule:: pybricks.tools
Expand Down

0 comments on commit 1c5e390

Please sign in to comment.