Re: GCC documentation: porting to Sphinx

2021-08-27 Thread Martin Liška
On 8/10/21 17:43, Martin Liška wrote: Hello. I've just pushed the rebased branch here: https://gcc.gnu.org/git/gitweb.cgi?p=gcc.git;a=log;h=refs/users/marxin/heads/sphinx-v4 which I force push once I rebase it. One can fetch the branch with: $ git fetch origin refs/users/marxin/heads/sphinx-v4

Re: GCC documentation: porting to Sphinx

2021-08-10 Thread Martin Liška
Hello. I've just pushed the rebased branch here: https://gcc.gnu.org/git/gitweb.cgi?p=gcc.git;a=log;h=refs/users/marxin/heads/sphinx-v4 which I force push once I rebase it. One can fetch the branch with: $ git fetch origin refs/users/marxin/heads/sphinx-v4 Generated output (directly made from G

Re: GCC documentation: porting to Sphinx

2021-06-30 Thread Martin Liška
On 6/29/21 5:54 PM, Arnaud Charlet wrote: In particular can you explain the motivation behind all the changes in the gcc/ada/doc directory? Sure: 1) All Sphinx manuals live in a directory where index page is called index.rst. That's why I moved e.g. this: gcc/ada/doc/{gnat_rm.rst => gnat_rm/in

Re: GCC documentation: porting to Sphinx

2021-06-29 Thread Arnaud Charlet
> >In particular can you explain the motivation behind all the changes in the > >gcc/ada/doc directory? > > Sure: > 1) All Sphinx manuals live in a directory where index page is called > index.rst. That's why > I moved e.g. this: gcc/ada/doc/{gnat_rm.rst => gnat_rm/index.rst} > 2) I moved latex_e

Re: GCC documentation: porting to Sphinx

2021-06-28 Thread Martin Liška
On 6/28/21 12:23 PM, Arnaud Charlet wrote: I've got something that is very close to be a patch candidate that can be eventually merged. Right now, the patches are available here: https://gcc.gnu.org/git/gitweb.cgi?p=gcc.git;a=log;h=refs/users/marxin/heads/sphinx-v3 FWIW I would prefer to review

Re: GCC documentation: porting to Sphinx

2021-06-28 Thread Arnaud Charlet
> I've got something that is very close to be a patch candidate that can be > eventually merged. Right now, the patches are available here: > https://gcc.gnu.org/git/gitweb.cgi?p=gcc.git;a=log;h=refs/users/marxin/heads/sphinx-v3 FWIW I would prefer to review the changes posted here directly with a

Re: GCC documentation: porting to Sphinx

2021-06-25 Thread Martin Liška
On 6/25/21 3:11 PM, Martin Liška wrote: List of known issues (planned to be fixed after merging): I forgot about: - diagnostics URL (for e.g. warnings) needs to be adjusted Martin

Re: GCC documentation: porting to Sphinx

2021-06-25 Thread Martin Liška
Hello. I've got something that is very close to be a patch candidate that can be eventually merged. Right now, the patches are available here: https://gcc.gnu.org/git/gitweb.cgi?p=gcc.git;a=log;h=refs/users/marxin/heads/sphinx-v3 Changes since last version: - gdc manual was ported - 'make doc'

Re: GCC documentation: porting to Sphinx

2021-06-24 Thread Martin Liška
On 6/23/21 6:00 PM, Joseph Myers wrote: On Wed, 23 Jun 2021, Martin Liška wrote: @Joseph: Can you share your thoughts about the used Makefile integration? What do you suggest for 2) (note that explicit listing of all .rst file would be crazy)? You can write dependencies on e.g. doc/gcc/*.rst

Re: GCC documentation: porting to Sphinx

2021-06-23 Thread Joseph Myers
On Wed, 23 Jun 2021, Martin Liška wrote: > @Joseph: Can you share your thoughts about the used Makefile integration? What > do you suggest for 2) > (note that explicit listing of all .rst file would be crazy)? You can write dependencies on e.g. doc/gcc/*.rst (which might be more files than actua

Re: GCC documentation: porting to Sphinx

2021-06-23 Thread Martin Liška
Hello. I've just made a first version of the patchset that sits in GCC source tree: https://gcc.gnu.org/git/gitweb.cgi?p=gcc.git;a=log;h=refs/users/marxin/heads/sphinx-v2 Changes since the last submission: 1) I made a brief proofreading and fixed most of the formatting and other issues 2) target

Re: GCC documentation: porting to Sphinx

2021-06-11 Thread Koning, Paul via Gcc
> On Jun 11, 2021, at 11:50 AM, Joseph Myers wrote: > > ... > > "make" at top level should build all the info manuals and man pages, as at > present (if a suitable Sphinx version is installed), and "make install" > should install them, in the same directories as at present. > > "make html"

Re: GCC documentation: porting to Sphinx

2021-06-11 Thread Joseph Myers
On Fri, 11 Jun 2021, Martin Liška wrote: > > Where languages have their own manuals, I think it's more appropriate for > > those to go under the language-specific directories. > > So it will require the following folder structure: > > $gccroot/gcc/doc/gcc - for GCC documentation > $gccroot/gcc/d

Re: GCC documentation: porting to Sphinx

2021-06-11 Thread Martin Liška
On 6/11/21 1:48 AM, Martin Sebor wrote: On 6/10/21 7:18 AM, Martin Liška wrote: On 6/10/21 11:07 AM, Martin Liška wrote: Doing that, one has 2 unique links, that would be needed for get_option_url  function. Plus, both :option:`-Wfoo` and :option:`-Wno-foo` references are going to work. And I

Re: GCC documentation: porting to Sphinx

2021-06-11 Thread Martin Liška
On 6/10/21 6:49 PM, Joseph Myers wrote: On Thu, 10 Jun 2021, Martin Liška wrote: 1) Can we organize the new documentation in $gccroot/doc folder similarly to what I have in texi2rst-generated repo? Would be beneficial as we can have a single Makefile and shared content will be in a same depth t

Re: GCC documentation: porting to Sphinx

2021-06-10 Thread Martin Sebor via Gcc
On 6/10/21 7:18 AM, Martin Liška wrote: On 6/10/21 11:07 AM, Martin Liška wrote: Doing that, one has 2 unique links, that would be needed for get_option_url function. Plus, both :option:`-Wfoo` and :option:`-Wno-foo` references are going to work. And I've actually did the transformation and

Re: GCC documentation: porting to Sphinx

2021-06-10 Thread Joseph Myers
On Thu, 10 Jun 2021, Martin Liška wrote: > 1) Can we organize the new documentation in $gccroot/doc folder > similarly to what I have in texi2rst-generated repo? Would be beneficial > as we can have a single Makefile and shared content will be in a same > depth to the individual manuals. Where

Re: GCC documentation: porting to Sphinx

2021-06-10 Thread Martin Liška
On 6/2/21 7:27 PM, Joseph Myers wrote: On Mon, 31 May 2021, Martin Liška wrote: https://splichal.eu/scripts/sphinx/ Looking at some examples there: https://splichal.eu/scripts/sphinx/gcc/_build/html/c-implementation-defined-behavior/preprocessing-directives.html has some conversion problems:

Re: GCC documentation: porting to Sphinx

2021-06-10 Thread Martin Liška
On 6/10/21 11:07 AM, Martin Liška wrote: Doing that, one has 2 unique links, that would be needed for get_option_url  function. Plus, both :option:`-Wfoo` and :option:`-Wno-foo` references are going to work. And I've actually did the transformation and one can see it e.g. here: https://splichal

Re: GCC documentation: porting to Sphinx

2021-06-10 Thread Martin Liška
On 6/4/21 5:10 PM, Martin Sebor wrote: On 6/3/21 4:56 AM, Martin Liška wrote: On 6/2/21 10:41 PM, Martin Sebor wrote: On 5/31/21 7:25 AM, Martin Liška wrote: Hello. I've made quite some progress with the porting of the documentation and I would like to present it to the community now: https:/

Re: GCC documentation: porting to Sphinx

2021-06-04 Thread Martin Sebor via Gcc
On 6/3/21 4:56 AM, Martin Liška wrote: On 6/2/21 10:41 PM, Martin Sebor wrote: On 5/31/21 7:25 AM, Martin Liška wrote: Hello. 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/ Hello.

Re: GCC documentation: porting to Sphinx

2021-06-04 Thread Martin Liška
On 6/3/21 7:16 PM, Joseph Myers wrote: On Thu, 3 Jun 2021, Martin Liška wrote: On 6/2/21 6:44 PM, Joseph Myers wrote: On Wed, 2 Jun 2021, Joel Sherrill wrote: For RTEMS, we switched from texinfo to Sphinx and the dependency on Python3 for Sphinx has caused a bit of hassle. Is this going to b

Re: GCC documentation: porting to Sphinx

2021-06-03 Thread Joseph Myers
On Thu, 3 Jun 2021, Martin Liška wrote: > On 6/2/21 6:44 PM, Joseph Myers wrote: > > On Wed, 2 Jun 2021, Joel Sherrill wrote: > > > > > For RTEMS, we switched from texinfo to Sphinx and the dependency > > > on Python3 for Sphinx has caused a bit of hassle. Is this going to be > > > an issue for G

Re: GCC documentation: porting to Sphinx

2021-06-03 Thread Martin Liška
On 6/2/21 6:44 PM, Joseph Myers wrote: On Wed, 2 Jun 2021, Joel Sherrill wrote: For RTEMS, we switched from texinfo to Sphinx and the dependency on Python3 for Sphinx has caused a bit of hassle. Is this going to be an issue for GCC? What Sphinx (and, thus, Python) versions does the GCC manual

Re: GCC documentation: porting to Sphinx

2021-06-03 Thread Martin Liška
On 6/2/21 10:41 PM, Martin Sebor wrote: On 5/31/21 7:25 AM, Martin Liška wrote: Hello. 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/ Hello. Thank you for the review. Just a few

Re: GCC documentation: porting to Sphinx

2021-06-02 Thread Martin Sebor via Gcc
On 5/31/21 7:25 AM, Martin Liška wrote: Hello. 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/ Just a few issues I noticed in the warnings section: The headings of some warnings mentio

Re: GCC documentation: porting to Sphinx

2021-06-02 Thread Joseph Myers
On Mon, 31 May 2021, Martin Liška wrote: > https://splichal.eu/scripts/sphinx/ Looking at some examples there: https://splichal.eu/scripts/sphinx/gcc/_build/html/c-implementation-defined-behavior/preprocessing-directives.html has some conversion problems: * "See Implementation-defined behavio

Re: GCC documentation: porting to Sphinx

2021-06-02 Thread Joseph Myers
On Wed, 2 Jun 2021, Joel Sherrill wrote: > For RTEMS, we switched from texinfo to Sphinx and the dependency > on Python3 for Sphinx has caused a bit of hassle. Is this going to be > an issue for GCC? What Sphinx (and, thus, Python) versions does the GCC manual build work with? Can it work with

Re: GCC documentation: porting to Sphinx

2021-06-02 Thread Joel Sherrill
For RTEMS, we switched from texinfo to Sphinx and the dependency on Python3 for Sphinx has caused a bit of hassle. Is this going to be an issue for GCC? Also we rely on TexLive for PDF output and that's a bit of a pain to install. Tex was incorrectly packaged on some RHEL/CentOS versions. This ig

Re: GCC documentation: porting to Sphinx

2021-06-02 Thread Martin Liška
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 com

Re: GCC documentation: porting to Sphinx

2021-06-01 Thread Michael Matz
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: > >>

Re: GCC documentation: porting to Sphinx

2021-06-01 Thread Martin Liška
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

Re: GCC documentation: porting to Sphinx

2021-05-31 Thread Michael Matz
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

GCC documentation: porting to Sphinx

2021-05-31 Thread Martin Liška
Hello. 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]). It's built on the devel/sphinx G