From a3421de77265505d13ca051618fb0095ba4cf176 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Sat, 13 Jul 2019 03:20:38 +0200
Subject: [PATCH] doc: Improve link structure
Signed-off-by: Rahix <rahix@rahix.de>
---
Documentation/epicardium/overview.rst | 2 ++
Documentation/index.rst | 9 +++------
Documentation/overview.rst | 10 ++++++----
Documentation/pycardium/overview.rst | 2 ++
4 files changed, 13 insertions(+), 10 deletions(-)
diff --git a/Documentation/epicardium/overview.rst b/Documentation/epicardium/overview.rst
index 6425fed7..a63bcdac 100644
--- a/Documentation/epicardium/overview.rst
+++ b/Documentation/epicardium/overview.rst
@@ -1,3 +1,5 @@
+.. _epicardium_api_overview:
+
Overview
========
Epicardium, the "main" firmware running on core 0, exposes a lot of
diff --git a/Documentation/index.rst b/Documentation/index.rst
index be83c75d..a21782c9 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -8,15 +8,14 @@ includes the Python modules that are available but also documentation of the
lower level firmware components.
If you want to write Python code for card10, you will want to take a look at
-the :ref:`pycardium_index` docs. If you are interested in writing applications
+the :ref:`Pycardium <pycardium_overview>` docs. If you are interested in writing applications
in other languages, you'll probably want to interface with
-:ref:`epicardium_api_index` directly.
+:ref:`Epicardium API <epicardium_api_overview>` directly.
Last but not least, if you want to start hacking the lower-level firmware, the
-:ref:`firmware_index` section of these docs is a good starting place.
+:ref:`Firmware <firmware_overview>` section of these docs is a good starting place.
-.. _pycardium_index:
.. toctree::
:maxdepth: 1
:caption: Pycardium
@@ -25,7 +24,6 @@ Last but not least, if you want to start hacking the lower-level firmware, the
pycardium/color
pycardium/leds
-.. _epicardium_api_index:
.. toctree::
:maxdepth: 1
:caption: Epicardium API
@@ -33,7 +31,6 @@ Last but not least, if you want to start hacking the lower-level firmware, the
epicardium/overview
epicardium/api
-.. _firmware_index:
.. toctree::
:maxdepth: 1
:caption: Firmware
diff --git a/Documentation/overview.rst b/Documentation/overview.rst
index 8fdc0336..2f0f465e 100644
--- a/Documentation/overview.rst
+++ b/Documentation/overview.rst
@@ -1,3 +1,5 @@
+.. _firmware_overview:
+
Overview
========
To make the most of card10's dual-core processor, its firmware will have been
@@ -9,8 +11,8 @@ this will have been *Pycardium*, our MicroPython port.
Epicardium
----------
-Epicardium is based on `FreeRTOS`_. There are a number of tasks that will have
-been keeping card10 running. These are:
+Epicardium is based on `FreeRTOS <https://www.freertos.org/>`_. There are a
+number of tasks that will have been keeping card10 running. These are:
* **Dispatcher**: The dispatcher task handles API calls from core 1.
* **PMIC**: The power manager task checks the battery level and other interesting
@@ -22,10 +24,10 @@ been keeping card10 running. These are:
The following tasks have not yet been implemented/are currently in the works:
- - **Bluetooth**: The bluetooth stack
+ - **Bluetooth**: The bluetooth stack (`#23`_)
- **Payload Controller**: Control what is running on core 1
-.. _FreeRTOS: https://www.freertos.org/
+ .. _#23: https://git.card10.badge.events.ccc.de/card10/firmware/issues/23
Pycardium
---------
diff --git a/Documentation/pycardium/overview.rst b/Documentation/pycardium/overview.rst
index ded98271..d011dbfc 100644
--- a/Documentation/pycardium/overview.rst
+++ b/Documentation/pycardium/overview.rst
@@ -1,3 +1,5 @@
+.. _pycardium_overview:
+
Overview
========
Pycardium is what we call our MicroPython port for card10. For the most part,
--
GitLab