diff --git a/Documentation/conf.py b/Documentation/conf.py index ae5361ac408293b054274b0051bbad963da2a738..bb211aa0cf679dd8486cc21ed5bcbc56418a3d7f 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 1db20eda46d7496588a15b56576b9f2a071821b3..14e82431cbe77e42648f66ef239ef99c87a8ea47 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 1fb0ddb954a53dfd04282e16aa549a2de5a9a726..5eccd6a448ddda30d663dedbaab266f3bfd89d74 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 4eea7d3fee2f2af194c669d4b24b768be41928ca..eb34e17b9401b02993b11a857d084f3d19202d25 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 + * ======== */ /**