Re: [PATCH libgpiod 5/5] doc: use sphinx in conjunction with doxygen

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

 



On Thu, Jan 2, 2025 at 6:08 PM Erik Schilling <erik.schilling@xxxxxxxxxx> wrote:
>
> On Fri Dec 20, 2024 at 5:46 PM CET, Bartosz Golaszewski wrote:
> > From: Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx>
> >
> >
> > -All API symbols exposed by the core C API and C++ bindings are documented with
> > -doxygen markup blocks. Doxygen documentation can be generated by executing
> > -'make doc' given that the doxygen executable is available in the system.
> > +The project uses sphinx to automatically generate the documentation. The system
> > +needs to provide doxygen and sphinx-build programs. With those in place, the
> > +build can be invoked with 'make doc'. This generates documentation for the core
> > +C API as well as C++ and python bindings.
>
> I also lacked the `breathe` package. Maybe worth mentioning here?
>
> - Erik

There's a v2 on the list and it has a requirements.txt.

Bart





[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