From 374010e0439e59bce76bdf68c7cab51fd170cfa9 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Mon, 12 Aug 2019 16:15:02 +0200
Subject: [PATCH] docs: Add indexes and properly declare modules
Signed-off-by: Rahix <rahix@rahix.de>
---
Documentation/index.rst | 7 +++++++
Documentation/pycardium/color.rst | 2 ++
Documentation/pycardium/light-sensor.rst | 2 ++
Documentation/pycardium/utime.rst | 2 ++
Documentation/pycardium/vibra.rst | 2 ++
5 files changed, 15 insertions(+)
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 1fe90f2e..50fdc4af 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -47,3 +47,10 @@ Last but not least, if you want to start hacking the lower-level firmware, the
epicardium/overview
epicardium/api
epicardium-guide
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/Documentation/pycardium/color.rst b/Documentation/pycardium/color.rst
index d4c95d53..ae654b13 100644
--- a/Documentation/pycardium/color.rst
+++ b/Documentation/pycardium/color.rst
@@ -21,6 +21,8 @@ The color module also contains a few constanst for commonly used colors:
.. py:data:: color.MAGENTA
.. py:data:: color.CYAN
+.. py:module:: htmlcolor
+
``htmlcolor`` - Color Constants
===============================
The ``htmlcolor`` module contains even more color constants. Note
diff --git a/Documentation/pycardium/light-sensor.rst b/Documentation/pycardium/light-sensor.rst
index f07df5ca..daf34a3e 100644
--- a/Documentation/pycardium/light-sensor.rst
+++ b/Documentation/pycardium/light-sensor.rst
@@ -1,3 +1,5 @@
+.. py:module:: light_sensor
+
``light_sensor`` - Ambient Brightness
=====================================
On the harmonic board, there is an IR-LED which can be used in reverse as a
diff --git a/Documentation/pycardium/utime.rst b/Documentation/pycardium/utime.rst
index c765d2fe..958c888c 100644
--- a/Documentation/pycardium/utime.rst
+++ b/Documentation/pycardium/utime.rst
@@ -1,3 +1,5 @@
+.. py:module:: utime
+
``utime`` - Time
================
The ``utime`` module loosely follows CPython's |time|_ module, but is heavily
diff --git a/Documentation/pycardium/vibra.rst b/Documentation/pycardium/vibra.rst
index 096e200c..1cefbdaa 100644
--- a/Documentation/pycardium/vibra.rst
+++ b/Documentation/pycardium/vibra.rst
@@ -1,3 +1,5 @@
+.. py:module:: vibra
+
``vibra`` - Vibration Motor
===========================
--
GitLab