pw_spi_rp2040: Add module metadata

Bug: 339741960 Change-Id: I3269dae322c0cb4b710b6eb5863113e38a4c88ec Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/214232 Lint: Lint 🤖 <[email protected]> Commit-Queue: Auto-Submit <[email protected]> Pigweed-Auto-Submit: Kayce Basques <[email protected]> Reviewed-by: Anthony DiGirolamo <[email protected]> Presubmit-Verified: CQ Bot Account <[email protected]>
google · Jun 5, 2024 · f8259a3 · f8259a3
1 parent 2803e38
commit f8259a3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/docs/module_metadata.json b/docs/module_metadata.json
@@ -248,6 +248,13 @@
       "C++20"
     ]
   },
+  "pw_spi_rp2040": {
+    "tagline": "Raspberry Pi RP2040 backend for pw_spi",
+    "status": "unstable",
+    "languages": [
+      "C++"
+    ]
+  },
   "pw_status": {
     "tagline": "Exception-free error propagation for embedded",
     "status": "stable",

diff --git a/pw_spi_rp2040/docs.rst b/pw_spi_rp2040/docs.rst
@@ -3,16 +3,19 @@
 ==============
  pw_spi_rp2040
 ==============
+.. pigweed-module::
+   :name: pw_spi_rp2040
 
-``pw_spi_rp2040`` implements the ``pw_spi`` interface using the
+``pw_spi_rp2040`` implements the :ref:`module-pw_spi` interface using the
 `Raspberry Pi Pico SDK <https://github.com/raspberrypi/pico-sdk/>`_.
 
-The implementation is based on the SPI driver in pico_sdk. SPI transfers use
-the blocking driver API which uses busy waiting under the hood.
+The implementation is based on the SPI driver from the Pico SDK. SPI transfers
+use the blocking driver API which uses busy waiting under the hood.
 
 .. note::
    There is currently no support for RP2040 hardware CSn
-   pins. ~pw::spi::DigitalOutChipSelector~ is used instead.
+   pins. :cpp:class:`pw::spi::DigitalOutChipSelector` is
+   used instead.
 
 Usage
 =====