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

[Vincent Fazio <vfazio@xxxxxxxxxxx>]

> -----Original Message-----
> From: Bartosz Golaszewski <brgl@xxxxxxxx>
> Sent: Tuesday, February 11, 2025 6:59 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 v4 00/17] doc: improvements for
> ReadTheDocs
> 
> 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.
> 
> First 10 preparatory patches address existing issues in code documentation.
> Patches 11-15 add sphinx docs for all project sections and last patch moves
> most README contents into sphinx as well.
> 
> I allowed myself to publish this branch on RTD for testing purposes.
> 
> Once this is merged, I'l backport these changes to the v2.2.x branch so that
> the documentation for the most recent release can become available online
> too.
> 
> Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx>

Reviewed-by: Vincent Fazio <vfazio@xxxxxxxxxxx>