public inbox for gcc@gcc.gnu.org
 help / color / mirror / Atom feed
From: "Martin Liška" <mliska@suse.cz>
To: Paul Iannetta <piannetta@kalrayinc.com>
Cc: GCC Patches <gcc-patches@gcc.gnu.org>,
	GCC Development <gcc@gcc.gnu.org>,
	Sandra Loosemore <sandra@codesourcery.com>,
	"Joseph S. Myers" <joseph@codesourcery.com>
Subject: Re: Announcement: Porting the Docs to Sphinx - 9. November 2022
Date: Wed, 19 Oct 2022 09:24:06 +0200	[thread overview]
Message-ID: <aab3e770-c706-88f5-83fe-dbbecd7f39bb@suse.cz> (raw)
In-Reply-To: <20221017141610.zaoysaggompepcij@ws2202.lin.mbt.kalray.eu>

On 10/17/22 16:16, Paul Iannetta wrote:
> Hi Martin,
> 
> Thank you very much for porting the documentation to Sphinx, it is
> very convenient to use, especially the menu on the left and the
> search bar.

Thanks, I also like it!

> 
> However, I also regularly browse and search the documentation through
> info, especially when I want to use regexps to search or need to
> include a special character (eg.,+,-,_,(; this can happen when I
> search for '(define' ) for example) in the search string.
> 
> Does the port to Sphinx means the end of texinfo? Or, will both be
> available as it is the case now with the official texinfo and your
> unofficial splichal.eu pages.

It will be still available same as now where manual pages and info pages
are built if you compile GCC from sources. We haven't been publishing manual
pages and info pages on our web pages, people typically get these from
their distribution packages.

Does it help? Or do you expect any change regarding what we publish at:
https://gcc.gnu.org/onlinedocs/
?

Cheers,
Martin

> 
> Paul
> 
> On Mon, Oct 17, 2022 at 03:28:34PM +0200, Martin Liška wrote:
>> Hello.
>>
>> Based on the very positive feedback I was given at the Cauldron Sphinx Documentation BoF,
>> I'm planning migrating the documentation on 9th November. There are still some minor comments
>> from Sandra when it comes to the PDF output, but we can address that once the conversion is done.
>>
>> The reason I'm sending the email now is that I was waiting for latest Sphinx release (5.3.0) that
>> simplifies reference format for options and results in much simpler Option summary section ([1])
>>
>> The current GCC master (using Sphinx 5.3.0) converted docs can be seen here:
>> https://splichal.eu/scripts/sphinx/
>>
>> If you see any issues with the converted documentation, or have a feedback about it,
>> please reply to this email.
>>
>> Cheers,
>> Martin
>>
>> [1] https://github.com/sphinx-doc/sphinx/pull/10840
>> [1] https://splichal.eu/scripts/sphinx/gcc/_build/html/gcc-command-options/option-summary.html
>>
>>
>>
>>
> 
> 
> 
> 


  reply	other threads:[~2022-10-19  7:24 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-31 14:06 Porting the Docs to Sphinx - project status Martin Liška
2022-02-04 13:40 ` Matthias Klose
2022-03-08 15:59   ` Martin Liška
2022-08-02 12:48 ` Martin Liška
2022-10-17 13:28   ` Announcement: Porting the Docs to Sphinx - 9. November 2022 Martin Liška
2022-10-17 14:16     ` Paul Iannetta
2022-10-19  7:24       ` Martin Liška [this message]
2022-10-19  8:13         ` Paul Iannetta
2022-10-19  9:22           ` Martin Liška
2022-10-19 16:42             ` Joseph Myers
2022-10-20 11:13               ` Martin Liška
2022-10-17 22:26     ` Sandra Loosemore
2022-10-19 11:09       ` Martin Liška
2022-10-19 12:45         ` Martin Liška
2022-10-19 16:30         ` Sandra Loosemore
2022-10-20 11:26           ` Martin Liška
2022-10-20  2:26     ` Xi Ruoyao
2022-10-20 11:27       ` Martin Liška
2022-10-20 11:49         ` Xi Ruoyao
2022-10-20 11:53           ` Martin Liška
2022-10-20 11:55             ` Xi Ruoyao
2022-10-20 12:26               ` Martin Liška
2022-10-20 15:35         ` Joseph Myers
2022-10-20 15:50           ` Martin Liška
2022-10-20 16:43             ` Joseph Myers
2022-10-20 16:47               ` Jakub Jelinek
2022-11-08 13:55                 ` Announcement: Porting the Docs to Sphinx - tomorrow Martin Liška
2022-11-08 18:44                   ` Sam James
2022-11-09  0:00                     ` Joseph Myers
2022-11-09  0:06                       ` Sam James
2022-11-09  7:49                         ` Richard Biener
2022-11-09 10:18                           ` Mark Wielaard
2022-11-09 17:11                           ` Joseph Myers
2022-11-09 17:16                             ` Richard Biener
2022-11-11 20:52                   ` Gerald Pfeifer
2022-11-11 21:10                     ` Sandra Loosemore
2022-11-13 15:44                       ` Martin Liška
2022-11-09 14:45               ` Announcement: Porting the Docs to Sphinx - 9. November 2022 Martin Liška
2022-11-09 17:14                 ` Joseph Myers
2022-11-10 13:05                   ` Martin Liška
2022-11-10 13:50                     ` Richard Biener
2022-11-11 23:05     ` David Malcolm

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=aab3e770-c706-88f5-83fe-dbbecd7f39bb@suse.cz \
    --to=mliska@suse.cz \
    --cc=gcc-patches@gcc.gnu.org \
    --cc=gcc@gcc.gnu.org \
    --cc=joseph@codesourcery.com \
    --cc=piannetta@kalrayinc.com \
    --cc=sandra@codesourcery.com \
    /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).