RE: [External] - [PATCH libgpiod v3 16/16] doc: move README contents to sphinx docs

[Vincent Fazio <vfazio@xxxxxxxxxxx>]

> -----Original Message-----
> From: Bartosz Golaszewski <brgl@xxxxxxxx>
> Sent: Thursday, February 6, 2025 6:22 AM
> To: Vincent Fazio <vfazio@xxxxxxxxxxx>; Kent Gibson
> <warthog618@xxxxxxxxx>; Linus Walleij <linus.walleij@xxxxxxxxxx>; Erik
> Schilling <erik.schilling@xxxxxxxxxx>; Phil Howard <phil@xxxxxxxxxxxxx>;
> Viresh Kumar <viresh.kumar@xxxxxxxxxx>
> Cc: Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx>; linux-
> gpio@xxxxxxxxxxxxxxx
> Subject: [External] - [PATCH libgpiod v3 16/16] doc: move README contents
> to sphinx docs
> 
> From: Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx>
> 
> 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.
> 
> Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx>
> ---
>  README                | 384 --------------------------------------------------
>  README.md             |  11 ++
>  docs/bindings.rst     |  25 +++-
>  docs/building.rst     |  74 ++++++++++
>  docs/contributing.rst |  45 ++++++
>  docs/cpp_api.rst      |   3 +
>  docs/dbus.rst         |  19 ++-
>  docs/glib_api.rst     |   3 +
>  docs/gpio_tools.rst   | 216 ++++++++++++++++++++++++++++
>  docs/gpiocli_top.rst  |  81 +++++++++++
>  docs/index.rst        |  23 ++-
>  docs/python_api.rst   |   8 ++
>  docs/testing.rst      |  46 ++++++
>  13 files changed, 544 insertions(+), 394 deletions(-)
> 
> diff --git a/docs/bindings.rst b/docs/bindings.rst
> index 73f1262..7f0f6b7 100644
> --- a/docs/bindings.rst
> +++ b/docs/bindings.rst
> @@ -10,8 +10,12 @@
>  High-level language bindings to libgpiod
>  ========================================
> 
> -The bindings provide a more straightforward interface to the base, low-level
> -C library.
> +Bindings provide a more straightforward interface to the core, low-level
> +C library. Object-oriented bindings for C++, GLib, python3 and Rust are
> +provided as part of the project. They can be enabled by passing
> +``--enable-bindings-cxx``, ``--enable-bindings-glib``,
> +``--enable-bindings-python`` and ``--enable-bindings-rust`` arguments to
> +configure respectively.
> 
>  .. toctree::
>     :maxdepth: 1
> @@ -20,3 +24,20 @@ C library.
>     cpp_api
>     python_api
>     glib_api
> +
> +.. warning::
> +   There's currently no good way of integrating rust documentation with
> sphinx.
> +   Rust bindings should be documented on https://docs.rs/ but due to a yet
> +   unsolved build problem, this is currently not the case. Please refer to the
> +   in-source comments for now.
> +
> +.. note::
> +   Rust bindings 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.
> +

Minor, but I get whitespace warnings when applying

Applying: doc: move README contents to sphinx docs
.git/rebase-apply/patch:457: trailing whitespace.

.git/rebase-apply/patch:463: new blank line at EOF.
+
warning: 2 lines add whitespace errors.

.. note::
    Rust bindings 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.
-