From f2f3f0500b3028469fdd15a618145c51547059e4 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Sat, 24 Aug 2019 09:25:49 +0200
Subject: [PATCH] chore: Fix docs
Signed-off-by: Rahix <rahix@rahix.de>
---
Documentation/conf.py | 4 +++-
Documentation/how-to-build.rst | 17 ++++++++++-------
Documentation/pycardium/max30001.rst | 2 +-
epicardium/epicardium.h | 4 ++--
4 files changed, 16 insertions(+), 11 deletions(-)
diff --git a/Documentation/conf.py b/Documentation/conf.py
index ae5361ac..bb211aa0 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -88,9 +88,11 @@ html_context = {
# -- Options for Auto-Doc ---------------------------------------------------- {{{
autodoc_mock_imports = [
+ "buttons",
+ "interrupt",
"sys_display",
"sys_leds",
- "buttons",
+ "sys_max30001",
"ucollections",
"urandom",
"utime",
diff --git a/Documentation/how-to-build.rst b/Documentation/how-to-build.rst
index 1db20eda..14e82431 100644
--- a/Documentation/how-to-build.rst
+++ b/Documentation/how-to-build.rst
@@ -28,20 +28,23 @@ Dependencies
.. code-block:: shell-session
dnf install arm-none-eabi-gcc arm-none-eabi-binutils arm-none-eabi-newlib
-
+
- macOS (Note: The card10 firmware team used Linux so far. macOS recommendations here are experimental.)
-
- You can use `Homebrew`_ to install the required tools.
- The version of the Arm crosscompiler tool chain is quite important; with the wrong version, e.g. strip and/or ld might throw strange errors.
-
+
+ You can use `Homebrew`_ to install the required tools. The version of the
+ ARM crosscompiler tool chain is quite important; with the wrong version,
+ e.g. strip and/or ld might throw strange errors.
+
.. code-block:: shell-session
-
+
brew tap px4/px4
brew install px4/px4/gcc-arm-none-eabi-63
brew install coreutils
+ .. _Homebrew: https://brew.sh/
+
- Alternative: Download `ARM's GNU toolchain`_. **TODO**
-.. _Homebrew: https://brew.sh/
+
* **python3**: For meson and various scripts needed for building.
* **meson** (>0.43.0) & **ninja**: Unfortunately most distros only have very old versions
diff --git a/Documentation/pycardium/max30001.rst b/Documentation/pycardium/max30001.rst
index 1fb0ddb9..5eccd6a4 100644
--- a/Documentation/pycardium/max30001.rst
+++ b/Documentation/pycardium/max30001.rst
@@ -1,5 +1,5 @@
``max30001`` - MAX30001
-=====================
+=======================
.. automodule:: max30001
:members:
diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h
index 4eea7d3f..eb34e17b 100644
--- a/epicardium/epicardium.h
+++ b/epicardium/epicardium.h
@@ -1638,8 +1638,8 @@ API_ISR(EPIC_INT_RTC_ALARM, epic_isr_rtc_alarm);
API(API_TRNG_READ, int epic_trng_read(uint8_t *dest, size_t size));
/**
- * MAX30001 API
- * ----------
+ * MAX30001
+ * ========
*/
/**
--
GitLab