GCC documentation: porting to Sphinx
Martin Liška
mliska@suse.cz
Tue Jun 1 07:31:21 GMT 2021
On 5/31/21 5:49 PM, Michael Matz wrote:
> Hello Martin,
>
> On Mon, 31 May 2021, Martin Liška wrote:
>
>> I've made quite some progress with the porting of the documentation and
>> I would like to present it to the community now:
>> https://splichal.eu/scripts/sphinx/
>>
>> Note the documentation is automatically ([1]) generated from texinfo with a
>> GitHub workflow ([2]).
>
> One other thing I was recently thinking about, in the Spinx vs. texinfo
> discussion: locally available documentation browsable/searchable in
> terminal with info(1) (or equivalents).
Yes, that's handy.
> I think the above (i.e.
> generating .rst from the texinfo file) would immediately nullify all my
> worries. So, just to be extra sure: your proposal now is to generate the
> .rst files, and that .texinfo remains the maintained sources, right?
No, .texinfo files will be gone. However, Sphinx can output to info format:
https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-M
And I've just added the generated Info pages here:
https://splichal.eu/scripts/sphinx/
Hope it helps?
Martin
>
>
> Ciao,
> Michael.
>
More information about the Gcc
mailing list