mirror of
https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git
synced 2026-10-28 13:55:08 +03:00
dda57bd63f
We now have comprehensive documentation available online on readthedocs. Let's not duplicate docs in README - move all information into the sphinx files. While at it: make the remaining README use markdown. Reviewed-by: Vincent Fazio <vfazio@xes-inc.com> Link: https://lore.kernel.org/r/20250211-improve-docs-v4-17-dc56702c2ca8@linaro.org Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
27 lines
972 B
ReStructuredText
27 lines
972 B
ReStructuredText
..
|
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
|
SPDX-FileCopyrightText: 2024-2025 Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
|
|
|
|
..
|
|
This file is part of libgpiod.
|
|
|
|
libgpiod GObject API documentation
|
|
|
|
libgpiod GObject bindings API
|
|
=============================
|
|
|
|
**GObject bindings** for libgpiod provide a high-level, object-oriented
|
|
interface to interact with GPIO (General Purpose Input/Output) lines on Linux
|
|
systems. These bindings leverage the **GObject framework**, commonly used in
|
|
GNOME and GTK+ applications, to wrap the lower-level C API of libgpiod.
|
|
|
|
.. note::
|
|
GLib bindings require GLib (as well as GObject, GIO and GIO-Unix) v2.80.
|
|
|
|
.. warning::
|
|
The documentation for GObject bindings is generated using gi-docgen and
|
|
cannot be easily integrated with sphinx documentation. Please navigate to
|
|
a separate section dedicated exclusively to the GLib part of the API.
|
|
|
|
`Navigate to GObject bindings documentation <Gpiodglib-1.0/index.html>`_
|