Re: Benefits of using Sphinx documentation format

2021-08-09 Thread Martin Liška
On 7/13/21 1:52 PM, Eli Zaretskii via Gcc wrote: From: Richard Biener Date: Tue, 13 Jul 2021 08:24:17 +0200 Cc: Eli Zaretskii , "gcc@gcc.gnu.org" I actually like texinfo (well, because I know it somewhat, compare to sphinx). I think it produces quite decent PDF manuals. I never use the html o

Re: Benefits of using Sphinx documentation format

2021-08-09 Thread Martin Liška
On 7/12/21 7:49 PM, Gavin Smith via Gcc wrote: (Sending mail again, without attachments this time in the hope it gets through.) I had the discussion about moving documentation of gcc from Sphinx to Texinfo brought to my attention. https://gcc.gnu.org/pipermail/gcc/2021-July/236731.html Speakin

Re: Benefits of using Sphinx documentation format

2021-07-13 Thread Jonathan Wakely via Gcc
On Tue, 13 Jul 2021 at 07:24, Richard Biener wrote: > > On Mon, Jul 12, 2021 at 7:20 PM Jonathan Wakely via Gcc > wrote: > > GCC devs and users who frequently modify or refer to the HTML docs > > want to replace texinfo. One vocal objector who just keeps repeating > > that texinfo is fine should

Re: Benefits of using Sphinx documentation format

2021-07-13 Thread Eli Zaretskii via Gcc
> From: Richard Biener > Date: Tue, 13 Jul 2021 14:46:33 +0200 > Cc: Jonathan Wakely , GCC Development > I can very well understand the use of the html manual when you want > to share pointers to specific parts of the documentation in communications. In the Emacs community, we have a notation fo

Re: Benefits of using Sphinx documentation format

2021-07-13 Thread Richard Biener via Gcc
On Tue, Jul 13, 2021 at 1:52 PM Eli Zaretskii wrote: > > > From: Richard Biener > > Date: Tue, 13 Jul 2021 08:24:17 +0200 > > Cc: Eli Zaretskii , "gcc@gcc.gnu.org" > > > > I actually like texinfo (well, because I know it somewhat, compare to > > sphinx). > > I think it produces quite decent PDF

Re: Benefits of using Sphinx documentation format

2021-07-13 Thread Eli Zaretskii via Gcc
> From: Richard Biener > Date: Tue, 13 Jul 2021 08:24:17 +0200 > Cc: Eli Zaretskii , "gcc@gcc.gnu.org" > > I actually like texinfo (well, because I know it somewhat, compare to sphinx). > I think it produces quite decent PDF manuals. I never use the html > output (in fact I read our manual usin

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Richard Biener via Gcc
On Mon, Jul 12, 2021 at 7:20 PM Jonathan Wakely via Gcc wrote: > > On Mon, 12 Jul 2021 at 18:04, Eli Zaretskii via Gcc wrote: > > > > > From: Matthias Kretz > > > Date: Mon, 12 Jul 2021 16:54:50 +0200 > > > > > > On Monday, 12 July 2021 16:30:23 CEST Martin Liška wrote: > > > > On 7/12/21 4:12 P

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Koning, Paul via Gcc
> On Jul 12, 2021, at 12:36 PM, David Malcolm via Gcc-patches > wrote: > > On Mon, 2021-07-12 at 15:25 +0200, Martin Liška wrote: >> ... > > I think the output formats we need to support are: > - HTML > - PDF > - man page (hardly "modern", but still used) Also info format (for the Emacs info

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Gavin Smith via Gcc
(Sending mail again, without attachments this time in the hope it gets through.) I had the discussion about moving documentation of gcc from Sphinx to Texinfo brought to my attention. https://gcc.gnu.org/pipermail/gcc/2021-July/236731.html Speaking as the Texinfo maintainer, I hope to add my vie

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Jonathan Wakely via Gcc
On Mon, 12 Jul 2021 at 18:24, Eli Zaretskii wrote: > > > From: Jonathan Wakely > > Date: Mon, 12 Jul 2021 18:15:26 +0100 > > Cc: Matthias Kretz , "gcc@gcc.gnu.org" > > > > > Gavin Smith, the GNU Texinfo maintainer, responded in detail to that > > > list. However, his message didn't get through t

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Eli Zaretskii via Gcc
> From: Jonathan Wakely > Date: Mon, 12 Jul 2021 18:15:26 +0100 > Cc: Matthias Kretz , "gcc@gcc.gnu.org" > > > Gavin Smith, the GNU Texinfo maintainer, responded in detail to that > > list. However, his message didn't get through to the list, for some > > reason. > > It did: > https://gcc.gnu.

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Jonathan Wakely via Gcc
On Mon, 12 Jul 2021 at 18:04, Eli Zaretskii via Gcc wrote: > > > From: Matthias Kretz > > Date: Mon, 12 Jul 2021 16:54:50 +0200 > > > > On Monday, 12 July 2021 16:30:23 CEST Martin Liška wrote: > > > On 7/12/21 4:12 PM, Eli Zaretskii wrote: > > > > I get it that you dislike the HTML produced by T

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Eli Zaretskii via Gcc
> From: Jonathan Wakely > Date: Mon, 12 Jul 2021 15:54:49 +0100 > Cc: Martin Liška , > "gcc@gcc.gnu.org" , gcc-patches > , > "Joseph S. Myers" > > You like texinfo. We get it. Would you please drop the attitude?

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Eli Zaretskii via Gcc
> Cc: h...@bitrange.com, gcc@gcc.gnu.org, gcc-patc...@gcc.gnu.org, > jos...@codesourcery.com > From: Martin Liška > Date: Mon, 12 Jul 2021 16:37:00 +0200 > > > 4) The need to learn yet another markup language. > > While this is not a problem for simple text, it does require a > > ser

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Eli Zaretskii via Gcc
> Cc: gcc@gcc.gnu.org, gcc-patc...@gcc.gnu.org, jos...@codesourcery.com > From: Martin Liška > Date: Mon, 12 Jul 2021 16:34:11 +0200 > > > "Texinfo must go" is one possible conclusion from your description. > > But it isn't the only one. An alternative is "the Texinfo source of > > the GCC manua

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Eli Zaretskii via Gcc
> From: Matthias Kretz > Date: Mon, 12 Jul 2021 16:54:50 +0200 > > On Monday, 12 July 2021 16:30:23 CEST Martin Liška wrote: > > On 7/12/21 4:12 PM, Eli Zaretskii wrote: > > > I get it that you dislike the HTML produced by Texinfo, but without > > > some examples of such bad HTML it is impossible

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread David Malcolm via Gcc
On Mon, 2021-07-12 at 15:25 +0200, Martin Liška wrote: > Hello. > > Let's make it a separate sub-thread where we can discuss motivation > why > do I want moving to Sphinx format. > > Benefits: > 1) modern looking HTML output (before: [1], after: [2]): "modern looking" is rather subjective; I'd r

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Jonathan Wakely via Gcc
On Mon, 12 Jul 2021 at 17:01, Gavin Smith wrote: > > On Mon, Jul 12, 2021 at 4:04 PM Jonathan Wakely via Gcc > wrote: > > GNU Hello has the same problem with its docs: > > https://www.gnu.org/software/hello/manual/hello.html#index-_002dg > > That URL is garbage because of the URL-encoded %2d char

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Gavin Smith via Gcc
On Mon, Jul 12, 2021 at 4:04 PM Jonathan Wakely via Gcc wrote: > GNU Hello has the same problem with its docs: > https://www.gnu.org/software/hello/manual/hello.html#index-_002dg > That URL is garbage because of the URL-encoded %2d character, and the > fact it links to the wrong place (the descrip

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Jonathan Wakely via Gcc
On Mon, 12 Jul 2021 at 15:52, Jonathan Wakely wrote: > > On Mon, 12 Jul 2021 at 15:13, Eli Zaretskii wrote: > > I get it that you dislike the HTML produced by Texinfo, but without > > some examples of such bad HTML it is impossible to know what exactly > > do you dislike and why. > > > > > You ca

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Jonathan Wakely via Gcc
On Mon, 12 Jul 2021 at 15:52, Jonathan Wakely wrote: > > On Mon, 12 Jul 2021 at 15:13, Eli Zaretskii wrote: > > > > > From: Jonathan Wakely > > > This is a problem with texinfo too. > > > > Not for someone who already knows Texinfo. We are talking about > > switching away of it, so I'm thinking

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Matthias Kretz
Hi. I'm commenting as a long-time GCC user and reader of the manual (never via info reader, mostly via DuckDuckGo / Google -> HTML docs) who recently started contributing more than just PRs. On Monday, 12 July 2021 16:30:23 CEST Martin Liška wrote: > On 7/12/21 4:12 PM, Eli Zaretskii wrote: > >

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Jonathan Wakely via Gcc
On Mon, 12 Jul 2021 at 15:13, Eli Zaretskii wrote: > > > From: Jonathan Wakely > > Date: Mon, 12 Jul 2021 14:53:44 +0100 > > Cc: Martin Liška , > > "gcc@gcc.gnu.org" , gcc-patches > > , > > "Joseph S. Myers" > > > > For me, these items are enough justification to switch away from >

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Martin Liška
On 7/12/21 3:39 PM, Eli Zaretskii wrote: Cc: gcc@gcc.gnu.org, gcc-patc...@gcc.gnu.org, jos...@codesourcery.com From: Martin Liška Date: Mon, 12 Jul 2021 15:25:47 +0200 Let's make it a separate sub-thread where we can discuss motivation why do I want moving to Sphinx format. Thanks for startin

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Martin Liška
On 7/12/21 4:16 PM, Eli Zaretskii wrote: From: Jonathan Wakely Date: Mon, 12 Jul 2021 15:05:11 +0100 Cc: Martin Liška , "gcc@gcc.gnu.org" , gcc-patches , "Joseph S. Myers" To be clear, I give links to users frequently (several times a week, every week, for decades) and prefer

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Martin Liška
On 7/12/21 4:12 PM, Eli Zaretskii wrote: From: Jonathan Wakely Date: Mon, 12 Jul 2021 14:53:44 +0100 Cc: Martin Liška , "gcc@gcc.gnu.org" , gcc-patches , "Joseph S. Myers" For me, these items are enough justification to switch away from texinfo, which produces crap HTML pages

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Eli Zaretskii via Gcc
> From: Jonathan Wakely > Date: Mon, 12 Jul 2021 15:05:11 +0100 > Cc: Martin Liška , > "gcc@gcc.gnu.org" , gcc-patches > , > "Joseph S. Myers" > > To be clear, I give links to users frequently (several times a week, > every week, for decades) and prefer to give them a link to spec

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Eli Zaretskii via Gcc
> From: Jonathan Wakely > Date: Mon, 12 Jul 2021 14:53:44 +0100 > Cc: Martin Liška , > "gcc@gcc.gnu.org" , gcc-patches > , > "Joseph S. Myers" > > For me, these items are enough justification to switch away from > texinfo, which produces crap HTML pages with crap anchors. If we w

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Jonathan Wakely via Gcc
On Mon, 12 Jul 2021 at 14:53, Jonathan Wakely wrote: > For me, these items are enough justification to switch away from > texinfo, which produces crap HTML pages with crap anchors. You can't > find out the anchors without inspecting (and searching) the HTML > source. That's utterly stupid. And even

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Jonathan Wakely via Gcc
On Mon, 12 Jul 2021 at 14:41, Eli Zaretskii via Gcc wrote: > > > Cc: gcc@gcc.gnu.org, gcc-patc...@gcc.gnu.org, jos...@codesourcery.com > > From: Martin Liška > > Date: Mon, 12 Jul 2021 15:25:47 +0200 > > > > Let's make it a separate sub-thread where we can discuss motivation why > > do I want mov

Re: Benefits of using Sphinx documentation format

2021-07-12 Thread Eli Zaretskii via Gcc
> Cc: gcc@gcc.gnu.org, gcc-patc...@gcc.gnu.org, jos...@codesourcery.com > From: Martin Liška > Date: Mon, 12 Jul 2021 15:25:47 +0200 > > Let's make it a separate sub-thread where we can discuss motivation why > do I want moving to Sphinx format. Thanks for starting this discussion. > Benefits:

Benefits of using Sphinx documentation format

2021-07-12 Thread Martin Liška
Hello. Let's make it a separate sub-thread where we can discuss motivation why do I want moving to Sphinx format. Benefits: 1) modern looking HTML output (before: [1], after: [2]): a) syntax highlighting for examples (code, shell commands, etc.) b) precise anchors, the current Texinfo anch