Skip to content

doc: add rust docs

Bartosz Golaszewski linux-gpio 2 versions – Applied

Status from this message: Applied, thanks!

Get series with b4
b4 am [email protected] change-id 20250604-rust-docs-502d6caf207b

Versions newest first

  1. v2 Latest3 patches 3 repliesApplied
  2. v13 patches 6 repliesSuperseded

Changes in v2 from the cover letter

- Pass --package=libgpiod to cargo doc to limit the scope of the docs to the user-facing API of libgpiod rust bindings
- Drop LD_LIBRARY_PATH and SYSTEM_DEPS_LIBGPIOD_SEARCH_NATIVE variables from the environment of cargo doc as they're not needed at build-time
- Link to v1: https://lore.kernel.org/r/[email protected]

Patches in v2 Applied

#Subject and filesSizeRepliesApplied
1/3doc: reformat conf.py with blackdocs/conf.py+1 -00 replies
2/3doc: improve the readability of the prefix variabledocs/conf.py+3 -30 replies
3/3doc: integrate rust docs into the sphinx build.readthedocs.yaml docs/conf.py docs/rust_api.rst+48 -150 replies

Reviews trailers per patch

None of the 3 patches has a Reviewed-by or Acked-by of their own; the series has one for all of them.

PatchErik SchillingViresh Kumar
SeriesR-b R-b
1/3
2/3
3/3

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v2 thread

Cover letter [PATCH libgpiod v2 0/3] doc: add rust docs

While full integration of Rust docs with sphinx is currently hard, if not impossible, we can still follow the pattern we used for GLib bindings and generate the docs using cargo, then linking to them from the sphinx page.

While at it: fix some minor issues in conf.py.

---
Changes in v2:
- Pass --package=libgpiod to cargo doc to limit the scope of the docs to the user-facing API of libgpiod rust bindings
- Drop LD_LIBRARY_PATH and SYSTEM_DEPS_LIBGPIOD_SEARCH_NATIVE variables from the environment of cargo doc as they're not needed at build-time
- Link to v1: https://lore.kernel.org/r/[email protected]

---
Bartosz Golaszewski (3):
doc: reformat conf.py with black
doc: improve the readability of the prefix variable
doc: integrate rust docs into the sphinx build

 .readthedocs.yaml |  3 +++
 docs/conf.py      | 43 ++++++++++++++++++++++++++++++++++---------
 docs/rust_api.rst | 22 ++++++++++++++--------
 3 files changed, 51 insertions(+), 17 deletions(-)

---
base-commit: 088c66ef20662b76eebf03e71f11196a5ae14b33
change-id: 20250604-rust-docs-502d6caf207b

Best regards,

Signature · 1 line
Bartosz Golaszewski <[email protected]>