Re: [PATCH libgpiod v4 00/17] doc: improvements for ReadTheDocs

[Bartosz Golaszewski <brgl@xxxxxxxx>]

From: Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx>


On Tue, 11 Feb 2025 13:59:21 +0100, Bartosz Golaszewski wrote:
> One thing that this project is missing is nicely looking, accessible and
> automatically updated documentation. I'd like to finally address it and
> replace our static doxygen pages with sphinx docs.
> 
> I spent some time playing with sphinx, doxygen, breathe and exhale. It
> turned out that exhale doesn't support doxygen groups and I really want
> to have them for the core C API to avoid having to manually assign each
> function to a specific module. That means we must use breathe on its own
> to integrate our existing doxygen docs with .rst.
> 
> [...]

I'm happy with the series so let's merge it and start building the official
docs from the master branch.

[01/17] build: set PACKAGE_URL
        commit: 588a196abbebc82eaa3495a9db4e9edfbaa44ed9
[02/17] bindings: cxx: doc: remove the gpiod_cxx doxygen group
        commit: e025e1cb5cbb5be933ab3d7b34cef2800a41eed1
[03/17] bindings: python: doc: update the docstring for gpiod.request_lines()
        commit: 8aa4d84b6f8e2d5d5fbb1b5c23d0eab69f9bf72a
[04/17] bindings: python: doc: make code examples appear as such in sphinx
        commit: b1bc6664f697c2aa693192d43f58d01b8210d3e5
[05/17] bindings: python: doc: describe undocumented members
        commit: d46e8f67aa45e2acbe8b918ff9815628167aea9b
[06/17] bindings: gpiod: reword the docstring for LineRequest.__init__()
        commit: 7ac26508931ce6aa8a5b2f9e45bcdeb4fb9d80a1
[07/17] bindings: glib: add the configuration file for gi-docgen
        commit: d0139ffa9c02b594e36681d3bb2b48932b3d573d
[08/17] dbus: daemon: add a more detailed description to help text
        commit: 681c0c2767944f668f2e6649ff0663ce4dbbcbd1
[09/17] dbus: client: tweak help text
        commit: 1ddfa9fc4b5b58bcf11a8852c5b71a66223de9ac
[10/17] dbus: improve comments in API xml
        commit: 91955a1f934452eafbc862de2b3392110cc338c0
[11/17] doc: create man entries for gpio-manager and gpiocli
        commit: 3b4a2ced02138c2837f99bfd1ed3773390ded74a
[12/17] doc: provide sphinx docs for the core C API and C++ bindings
        commit: 7e11886fffc095b9d3f211d49a49f96cfd73e578
[13/17] doc: add documentation for python bindings
        commit: 07da46218683322a246dfe5eda317589cd822a58
[14/17] doc: add documentation for GLib bindings
        commit: f37aaf2a6af66f22518091c7c58de596ff613010
[15/17] doc: add documentation for gpio-tools
        commit: 6f8b77c712a30ebea4089d317f4f8617287341cc
[16/17] doc: add documentation for D-Bus API, daemon and command-line client
        commit: bbcb5d44611d15d4db5d4f9fdb3362a0f84d7d10
[17/17] doc: move README contents to sphinx docs
        commit: dda57bd63f220d57bf80e3c1411ee612befda011

Best regards,
-- 
Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx>