1
0
mirror of https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git synced 2026-10-24 00:48:53 +03:00
Files
libgpiod/docs/rust_api.rst
Bartosz Golaszewski e4427590d9 doc: integrate rust docs into the sphinx build
Follow the pattern we established with GLib bindings: generate a separate
set of docs for the rust bindings, make them part of the generated doc
bundle and point to the rust index.html from the dedicated sphinx page.

Reviewed-by: Viresh Kumar <viresh.kumar@linaro.org>
Reviewed-by: Erik Schilling <erik@riscstar.com>
Link: https://lore.kernel.org/r/20250605-rust-docs-v2-3-883a0a3872c0@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
2025-06-10 09:43:03 +02:00

992 B

libgpiod Rust bindings API

Rust bindings for libgpiod aim to provide a memory-safe interface to the low-level C API. They are available on https://crates.io/ as the libgpiod package.

Note

When building the Rust bindings along the C library using make, they will be automatically configured to build against the build results of the C library. Building rust bindings requires cargo to be available on the system.

Warning

The documentation for Rust bindings is generated using cargo doc and cannot be easily integrated with sphinx documentation. Please navigate to a separate section dedicated exclusively to the Rust part of the API.

Navigate to Rust bindings documentation