RFC: Sphinx for GCC documentation

Koning, Paul Paul.Koning@dell.com
Thu Apr 1 13:42:50 GMT 2021


Can  it provide EPUB or MOBI output?  Some of the documentation systems used in various open source products have that capability, and that is very nice to have.  I have seen this from the one used by the Python project, for example.  Converting other formats to EPUB sometimes works tolerably well, but often not -- in particular, PDF to anything else is generally utterly unuseable, which is actually a design goal of PDF.

	paul

> On Apr 1, 2021, at 9:30 AM, Martin Liška <mliska@suse.cz> wrote:
> 
> Hey.
> 
> I've returned to the David's project and I'm willing to finish his transition effort.
> I believe using Sphinx documentation can rapidly improve readability, both HTML and PDF version,
> of various GCC manuals ([1]). I've spent some time working on the David's texi2rsf conversion tool ([2])
> and I'm presenting a result that is not perfect, but can be acceptable after a reasonable
> amount of manual modifications.
> 
> So far I focused on the 2 biggest manuals we have:
> 
> (1) User documentation
> https://splichal.eu/sphinx/
> https://splichal.eu/sphinx/gcc.pdf
> 
> (2) GCC Internals Manual
> https://splichal.eu/sphinx-internal
> https://splichal.eu/sphinx-internal/gccint.pdf
> 
> I'm aware of missing pieces (thanks Joseph) and I'm willing to finish it.
> 
> That said, I'm asking the GCC community for a green light before I invest
> more time on it?
> 
> Cheers,
> Martin
> 
> [1] https://gcc.gnu.org/onlinedocs/
> [2] https://github.com/davidmalcolm/texi2rst



More information about the Gcc-patches mailing list