gi-docgen drop-in replacement
This is a big task that will need to be divided into more sub-tasks when work is done in that area. This issue can be used to link to these sub-tasks, and have a good overview of the progress made.
Why
The gi-docgen HTML output doesn't please everyone, and creating the same output as GTK-Doc is a non-goal for gi-docgen.
A drop-in replacement
The idea is to create in GTK-Doc some programs that will have the same command-line interface (CLI) as gi-docgen, but produces a result similar to current GTK-Doc.
Additional files to provide compared to gi-docgen
Some additional files are necessary and are missing when using gi-docgen only. These include:
- The table of contents (TOC).
- The symbols listed in the desired order.
If these files are not provided, some default behavior would be useful, like listing everything alphabetically.
And if these files are created, it's of course better to have them upstream, but nothing prevents from shipping them as part of GTK-Doc. Like *.vapi
files for Vala.
Goal: GLib's and GTK's latest documentation available again with GTK-Doc
GLib 2.80 has removed the support for GTK-Doc and uses gi-docgen only. The GTK 4 documentation is available only with gi-docgen too.
So with a drop-in replacement of the gi-docgen binary, and by providing the additional files for the TOC and symbols, it would be possible to have again the GLib and GTK docs with the GTK-Doc format.