From f8259a3cb161f434028b9c189393b6b5a1abe76e Mon Sep 17 00:00:00 2001
From: Kayce Basques <kayce@google.com>
Date: Wed, 5 Jun 2024 19:59:28 +0000
Subject: [PATCH] pw_spi_rp2040: Add module metadata
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Bug: 339741960
Change-Id: I3269dae322c0cb4b710b6eb5863113e38a4c88ec
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/214232
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
Pigweed-Auto-Submit: Kayce Basques <kayce@google.com>
Reviewed-by: Anthony DiGirolamo <tonymd@google.com>
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
---
 docs/module_metadata.json |  7 +++++++
 pw_spi_rp2040/docs.rst    | 11 +++++++----
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/docs/module_metadata.json b/docs/module_metadata.json
index d4eccd7137..65fb8fcb8d 100644
--- 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
index 5a2f5b992c..35d1dd99fb 100644
--- 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
 =====