Skip to content
Snippets Groups Projects
Verified Commit f2f3f050 authored by rahix's avatar rahix
Browse files

chore: Fix docs


Signed-off-by: default avatarRahix <rahix@rahix.de>
parent ef03f13b
No related branches found
No related tags found
No related merge requests found
...@@ -88,9 +88,11 @@ html_context = { ...@@ -88,9 +88,11 @@ html_context = {
# -- Options for Auto-Doc ---------------------------------------------------- {{{ # -- Options for Auto-Doc ---------------------------------------------------- {{{
autodoc_mock_imports = [ autodoc_mock_imports = [
"buttons",
"interrupt",
"sys_display", "sys_display",
"sys_leds", "sys_leds",
"buttons", "sys_max30001",
"ucollections", "ucollections",
"urandom", "urandom",
"utime", "utime",
......
...@@ -28,20 +28,23 @@ Dependencies ...@@ -28,20 +28,23 @@ Dependencies
.. code-block:: shell-session .. code-block:: shell-session
dnf install arm-none-eabi-gcc arm-none-eabi-binutils arm-none-eabi-newlib 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.) - macOS (Note: The card10 firmware team used Linux so far. macOS recommendations here are experimental.)
You can use `Homebrew`_ to install the required tools. You can use `Homebrew`_ to install the required tools. The version of the
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. 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 .. code-block:: shell-session
brew tap px4/px4 brew tap px4/px4
brew install px4/px4/gcc-arm-none-eabi-63 brew install px4/px4/gcc-arm-none-eabi-63
brew install coreutils brew install coreutils
.. _Homebrew: https://brew.sh/
- Alternative: Download `ARM's GNU toolchain`_. **TODO** - Alternative: Download `ARM's GNU toolchain`_. **TODO**
.. _Homebrew: https://brew.sh/
* **python3**: For meson and various scripts needed for building. * **python3**: For meson and various scripts needed for building.
* **meson** (>0.43.0) & **ninja**: Unfortunately most distros only have very old versions * **meson** (>0.43.0) & **ninja**: Unfortunately most distros only have very old versions
......
``max30001`` - MAX30001 ``max30001`` - MAX30001
===================== =======================
.. automodule:: max30001 .. automodule:: max30001
:members: :members:
...@@ -1638,8 +1638,8 @@ API_ISR(EPIC_INT_RTC_ALARM, epic_isr_rtc_alarm); ...@@ -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)); API(API_TRNG_READ, int epic_trng_read(uint8_t *dest, size_t size));
/** /**
* MAX30001 API * MAX30001
* ---------- * ========
*/ */
/** /**
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment