Re: RFC: Experimental use of Sphinx for GCC documentation

2015-11-10 Thread Joseph Myers
On Mon, 9 Nov 2015, Sandra Loosemore wrote: > If we're going to switch documentation formats, I'd rather we used DocBook. > I've had to use "restructured text" before and found it really awkward. I should perhaps note that the Sphinx extensions to reST are a lot better documented than the ZWiki

Re: RFC: Experimental use of Sphinx for GCC documentation

2015-11-10 Thread David Malcolm
On Mon, 2015-11-09 at 16:37 -0700, Sandra Loosemore wrote: > On 11/08/2015 06:55 AM, David Malcolm wrote: > > I've been experimenting with using Sphinx [1] for GCC's documentation. > > > > [snip] > > > > The primary advantages of .rst/sphinx over .texi/texinfo I see are in > > the generated HTML:

Re: RFC: Experimental use of Sphinx for GCC documentation

2015-11-10 Thread Sandra Loosemore
[resending, gcc-patches won't allow a screenshot attachment] On 11/10/2015 03:27 PM, David Malcolm wrote: Correct, readable and well-organized documentation are laudable goals... but I think that, to a first approximation, we're already there: I just feel that the content is hidden behind a

Re: RFC: Experimental use of Sphinx for GCC documentation

2015-11-09 Thread Kyrill Tkachov
Hi David, On 08/11/15 13:55, David Malcolm wrote: I've been experimenting with using Sphinx [1] for GCC's documentation. You can see an HTML sample of GCC docs built with Sphinx here: https://dmalcolm.fedorapeople.org/gcc/2015-08-31/rst-experiment/gcc.html (it's a work-in-progress; i.e. there

Re: RFC: Experimental use of Sphinx for GCC documentation

2015-11-09 Thread Arnaud Charlet
> > We do have also a texi2rst script which handles 90% of the work, the > > rest requiring manual adaptations. I can send the script we've used if > > this can help. > > I'm interested in seeing your script. Can you post/upload it somewhere? Yes I will. Let me get the latest version we've used

Re: RFC: Experimental use of Sphinx for GCC documentation

2015-11-09 Thread David Malcolm
On Mon, 2015-11-09 at 16:54 +, Kyrill Tkachov wrote: > Hi David, > > On 08/11/15 13:55, David Malcolm wrote: > > I've been experimenting with using Sphinx [1] for GCC's documentation. > > > > You can see an HTML sample of GCC docs built with Sphinx here: > >

Re: RFC: Experimental use of Sphinx for GCC documentation

2015-11-09 Thread David Malcolm
On Sun, 2015-11-08 at 16:16 +0100, Arnaud Charlet wrote: > We've switched the Ada doc to sphinx indeed, so can only be > in favor of this change for the rest of GCC. > > We do have also a texi2rst script which handles 90% of the work, the > rest requiring manual adaptations. I can send the script

Re: RFC: Experimental use of Sphinx for GCC documentation

2015-11-09 Thread Arnaud Charlet
> > > We do have also a texi2rst script which handles 90% of the work, the > > > rest requiring manual adaptations. I can send the script we've used if > > > this can help. > > > > I'm interested in seeing your script. Can you post/upload it somewhere? > > Yes I will. Let me get the latest

Re: RFC: Experimental use of Sphinx for GCC documentation

2015-11-09 Thread Sandra Loosemore
On 11/08/2015 06:55 AM, David Malcolm wrote: I've been experimenting with using Sphinx [1] for GCC's documentation. [snip] The primary advantages of .rst/sphinx over .texi/texinfo I see are in the generated HTML: * sane, stable URLs (so e.g. there is a reliable URL for the docs for, say,

Re: RFC: Experimental use of Sphinx for GCC documentation

2015-11-09 Thread Joseph Myers
On Sun, 8 Nov 2015, David Malcolm wrote: > I've been experimenting with using Sphinx [1] for GCC's documentation. > > You can see an HTML sample of GCC docs built with Sphinx here: > https://dmalcolm.fedorapeople.org/gcc/2015-08-31/rst-experiment/gcc.html > (it's a work-in-progress; i.e. there

Re: RFC: Experimental use of Sphinx for GCC documentation

2015-11-08 Thread Arnaud Charlet
We've switched the Ada doc to sphinx indeed, so can only be in favor of this change for the rest of GCC. We do have also a texi2rst script which handles 90% of the work, the rest requiring manual adaptations. I can send the script we've used if this can help. Arno

RFC: Experimental use of Sphinx for GCC documentation

2015-11-08 Thread David Malcolm
I've been experimenting with using Sphinx [1] for GCC's documentation. You can see an HTML sample of GCC docs built with Sphinx here: https://dmalcolm.fedorapeople.org/gcc/2015-08-31/rst-experiment/gcc.html (it's a work-in-progress; i.e. there are bugs). Compare with: