This is the mail archive of the
mailing list for the GCC project.
use of sphinx/rest as source for GNAT doc
- From: Arnaud Charlet <charlet at adacore dot com>
- To: gcc at gcc dot gnu dot org
- Cc: Arnaud Charlet <charlet at adacore dot com>
- Date: Fri, 23 May 2014 17:23:46 +0200
- Subject: use of sphinx/rest as source for GNAT doc
- Authentication-results: sourceware.org; auth=none
At AdaCore, we have switched most of our product documentation the
rest/sphinx format: http://sphinx-doc.org/
which provides most of the advantages of texinfo (text format,
can generate output in multiple formats, supported by free software), as well
as additional advantages, at least for us (more modern output, actively
maintained, support more output formats, simpler syntax).
So we are investigating converting also the GNAT documentation
(GNAT User's Guide and GNAT RM) to this format.
I understand that GCC as whole likely wants to stick with texinfo
for the time being, so I'm not really suggesting a switch here, but
what about the following approach:
- the GNAT doc source would be in rest format (.rst files) instead
of texinfo (.texi files)
- we would still provide .texi files, generated automatically by the
sphinx toolset (via 'make texinfo') and committed in the repository
(similarly to configure vs configure.in/aclocal.m4), so end users
would not have any extra dependency, and generation of documentation
would still be possible from the .texi files directly
What do people think in principle about the above proposal?
Would that be an acceptable move for the GCC project?