Re: [libgpiod][PATCH] doc: fix sphinx config for rtd

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Fri, Jul 05, 2024 at 09:41:31AM +0200, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx>
>
>
> On Fri, 05 Jul 2024 10:17:50 +0800, Kent Gibson wrote:
> > Generating the latest documentation on readthedocs is broken as the
> > index.html generated by Doxygen is now being overwritten by one
> > generated by Sphinx.
> >
> > Make Sphinx generate a differently named root page that does not
> > conflict with the index.html generated by Doxygen.
> >
> > [...]
>
> Applied, thanks!
>
> [1/1] doc: fix sphinx config for rtd
>       commit: 824c1f39347c2ef46919dfc45e8247441b908827
>

Btw, I ran across this while updating RTD to v2.1 - their default build
config has changed since I last updated, so that didn't go as smoothly
as I had anticipated (the plan was to switch the branch the generation
uses from my fork to your github repo, but now that can wait til v2.2).

I am also looking at reworking the documentation to use Sphinx/Breathe
to generate the html from the xml that Doxygen generates, and
incorporting documentation for the Python bindings, but looking is
about as far as I've gotten so far.

Not sure what to do about the Rust bindings.  I was assuming I could
just link to docs.rs, but the build there[1] is broken.
Can we fix that?

Cheers,
Kent.

[1] https://docs.rs/crate/libgpiod/latest




[Index of Archives]     [Linux SPI]     [Linux Kernel]     [Linux ARM (vger)]     [Linux ARM MSM]     [Linux Omap]     [Linux Arm]     [Linux Tegra]     [Fedora ARM]     [Linux for Samsung SOC]     [eCos]     [Linux Fastboot]     [Gcc Help]     [Git]     [DCCP]     [IETF Announce]     [Security]     [Linux MIPS]     [Yosemite Campsites]

  Powered by Linux