From: "Martin Liška" <mliska@suse.cz>
To: Michael Matz <matz@suse.de>
Cc: David Malcolm <dmalcolm@redhat.com>,
gcc-patches@gcc.gnu.org, GCC Development <gcc@gcc.gnu.org>,
"Joseph S. Myers" <joseph@codesourcery.com>
Subject: Re: GCC documentation: porting to Sphinx
Date: Wed, 2 Jun 2021 09:36:00 +0200 [thread overview]
Message-ID: <bcc82c9a-56c1-4b72-c6aa-cc231b26c80f@suse.cz> (raw)
In-Reply-To: <alpine.LSU.2.22.394.2106011318230.16702@wotan.suse.de>
On 6/1/21 3:31 PM, Michael Matz wrote:
> Hello,
>
> On Tue, 1 Jun 2021, Martin Liška wrote:
>
>> 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
>
> I see, that's good to hear.
>
>> And I've just added the generated Info pages here:
>> https://splichal.eu/scripts/sphinx/
>
> Okay, but there's something amiss, just compare a local gcc.info with
> that. The sphinx generated one seems to only contain command line
> options, but none of the other topics, in particular it seems to contain
> the "Invoking GCC" chapter (and only that) as top-level, and all other
> ones are missing (like "C implementation", "C++ implementation", "C
> extension", and so on).
You are right, I reduced that to 'Invoking GCC', which is simply what 'man gcc'
presents. However, I moved that back to the entire GCC manual what you can
see now in the info page.
>
> Looking at gccint.info I also seem quite some confusion, it's unclear to
> me if content is missing or not. But e.g. the top-level structure has a
> different order (a less logical one, this one is btw. shared with the
> order of the HTML generated docu, so it's probably specific to sphinx
> setup or such).
Yes, the organization was bad and I fixed that. Now it's much better.
Martin
>
> Ignoring that missing content what is there right now does seem somewhat
> acceptable for local use, though.
>
>
> Ciao,
> Michael.
>
next prev parent reply other threads:[~2021-06-02 7:36 UTC|newest]
Thread overview: 113+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <1446990946.2994.192.camel@surprise>
[not found] ` <e7f490fc-ab76-5bc5-5e94-1d9f00f34b62@suse.cz>
2021-05-13 11:45 ` RFC: Sphinx for GCC documentation Martin Liška
2021-05-31 13:25 ` GCC documentation: porting to Sphinx Martin Liška
2021-05-31 15:49 ` Michael Matz
2021-06-01 7:31 ` Martin Liška
2021-06-01 13:31 ` Michael Matz
2021-06-02 7:36 ` Martin Liška [this message]
2021-06-02 16:05 ` Joel Sherrill
2021-06-02 16:44 ` Joseph Myers
2021-06-03 12:26 ` Martin Liška
2021-06-03 17:16 ` Joseph Myers
2021-06-04 7:27 ` Martin Liška
2021-06-02 17:27 ` Joseph Myers
2021-06-10 14:06 ` Martin Liška
2021-06-10 16:49 ` Joseph Myers
2021-06-11 14:33 ` Martin Liška
2021-06-11 15:50 ` Joseph Myers
2021-06-11 18:48 ` Koning, Paul
2021-06-23 13:13 ` Martin Liška
2021-06-23 16:00 ` Joseph Myers
2021-06-24 14:08 ` Martin Liška
2021-06-25 13:11 ` Martin Liška
2021-06-25 13:14 ` Martin Liška
2021-06-28 10:23 ` Arnaud Charlet
2021-06-28 10:44 ` Martin Liška
2021-06-29 15:54 ` Arnaud Charlet
2021-06-30 7:52 ` Martin Liška
2021-08-10 15:43 ` Martin Liška
2021-08-27 9:31 ` Martin Liška
2021-06-28 12:01 ` [PATCH] Port GCC documentation " Martin Liška
2021-06-28 15:33 ` Joseph Myers
2021-06-29 10:09 ` Martin Liška
2021-06-29 10:50 ` Richard Earnshaw
2021-06-30 4:47 ` Martin Liška
2021-06-30 10:14 ` Richard Earnshaw
2021-06-30 11:58 ` Martin Liška
2021-06-29 16:57 ` Eli Zaretskii
2021-06-29 18:01 ` Eli Zaretskii
2021-06-30 10:11 ` Martin Liška
2021-06-30 10:46 ` Martin Liška
2021-06-30 13:09 ` Eli Zaretskii
2021-07-01 12:44 ` Martin Liška
2021-07-01 13:33 ` Eli Zaretskii
2021-07-01 14:14 ` Martin Liška
2021-07-01 15:06 ` Michael Matz
2021-07-02 9:40 ` Martin Liška
2021-07-02 10:32 ` Eli Zaretskii
2021-07-01 15:44 ` Eli Zaretskii
2021-07-01 16:04 ` Martin Liška
2021-07-01 16:58 ` Eli Zaretskii
2021-07-02 9:30 ` Martin Liška
2021-07-02 10:31 ` Eli Zaretskii
2021-07-02 13:23 ` Martin Liška
2021-07-02 23:53 ` Hans-Peter Nilsson
2021-07-05 9:17 ` Richard Sandiford
2021-07-05 12:14 ` Eli Zaretskii
2021-07-05 13:03 ` Richard Sandiford
2021-07-12 13:25 ` Benefits of using Sphinx documentation format Martin Liška
2021-07-12 13:39 ` Eli Zaretskii
2021-07-12 13:53 ` Jonathan Wakely
2021-07-12 14:05 ` Jonathan Wakely
2021-07-12 14:16 ` Eli Zaretskii
2021-07-12 14:34 ` Martin Liška
2021-07-12 17:09 ` Eli Zaretskii
2021-07-12 14:12 ` Eli Zaretskii
2021-07-12 14:30 ` Martin Liška
2021-07-12 14:54 ` Matthias Kretz
2021-07-12 17:03 ` Eli Zaretskii
2021-07-12 17:15 ` Jonathan Wakely
2021-07-12 17:23 ` Eli Zaretskii
2021-07-12 17:33 ` Jonathan Wakely
2021-07-13 6:24 ` Richard Biener
2021-07-13 11:52 ` Eli Zaretskii
2021-07-13 12:46 ` Richard Biener
2021-07-13 12:55 ` Eli Zaretskii
2021-08-09 12:12 ` Martin Liška
2021-07-13 14:19 ` Jonathan Wakely
2021-07-12 14:52 ` Jonathan Wakely
2021-07-12 14:54 ` Jonathan Wakely
2021-07-12 17:14 ` Eli Zaretskii
2021-07-12 15:03 ` Jonathan Wakely
2021-07-12 16:00 ` Gavin Smith
2021-07-12 16:15 ` Jonathan Wakely
2022-07-05 12:27 ` Copiable anchor links in gcc manual Gavin Smith
2022-07-05 13:28 ` Jonathan Wakely
2021-07-12 14:37 ` Benefits of using Sphinx documentation format Martin Liška
2021-07-12 17:12 ` Eli Zaretskii
2021-07-12 16:36 ` David Malcolm
2021-07-12 18:23 ` Koning, Paul
2021-06-30 12:26 ` [PATCH] Port GCC documentation to Sphinx Martin Liška
2021-06-30 13:28 ` Martin Liška
2021-06-30 13:38 ` Eli Zaretskii
2021-06-30 14:04 ` Martin Liška
2021-06-30 15:43 ` Eli Zaretskii
2021-07-01 12:31 ` Martin Liška
2021-07-12 17:18 ` Martin Sebor
2021-08-09 12:18 ` Martin Liška
2021-07-13 14:54 ` Tamar Christina
2021-08-09 13:29 ` Martin Liška
2021-06-02 20:41 ` GCC documentation: porting " Martin Sebor
2021-06-03 10:56 ` Martin Liška
2021-06-04 15:10 ` Martin Sebor
2021-06-10 9:07 ` Martin Liška
2021-06-10 13:18 ` Martin Liška
2021-06-10 23:48 ` Martin Sebor
2021-06-11 14:34 ` Martin Liška
2021-06-04 7:55 ` RFC: Sphinx for GCC documentation Tobias Burnus
2021-06-04 14:24 ` Koning, Paul
2021-06-07 13:30 ` Martin Liška
2021-06-07 21:26 ` Bernhard Reutner-Fischer
2021-06-08 7:43 ` Martin Liška
2021-06-07 13:28 ` Martin Liška
2021-06-07 14:19 ` Tobias Burnus
2021-06-10 10:32 ` Martin Liška
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=bcc82c9a-56c1-4b72-c6aa-cc231b26c80f@suse.cz \
--to=mliska@suse.cz \
--cc=dmalcolm@redhat.com \
--cc=gcc-patches@gcc.gnu.org \
--cc=gcc@gcc.gnu.org \
--cc=joseph@codesourcery.com \
--cc=matz@suse.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).