Re: Announcement: Porting the Docs to Sphinx - 9. November 2022

["Martin Liška" <mliska@suse.cz>]

On 10/19/22 10:13, Paul Iannetta wrote:
> On Wed, Oct 19, 2022 at 09:24:06AM +0200, Martin Liška wrote:
>> 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.
> 
> As long as it is possible to build the info manual with "make info", even through
> something like rst2texinfo,  I would be happy.  Would it be possible
> to see the rst source of the port so as to try rst2texinfo on it?

Well, .rst source files can be seen right now here:
https://github.com/marxin/texi2rst-generated

And 'texinfo' is created with the standard Sphinx builder:
https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-b

> 
>>
>> Does it help? Or do you expect any change regarding what we publish at:
>> https://gcc.gnu.org/onlinedocs/
>> ?
> Currently, there is a tarball with texinfo sources for all the manuals
> for each version.

Well, then equivalent would be packaging all .rst files together with the corresponding
conf.py, logo.* and other files. But I don't see it much useful.

Thanks,
Martin

> 
> Thanks,
> Paul
> 
>>
>> 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
>>>>
>>>>
>>>>
>>>>
>>>
>>>
>>>
>>>
>>
>>
>>
>>
>>
> 
> 
> 
>