On 7/13/21 4:54 PM, Tamar Christina wrote:
Hi Martin,
-----Original Message-----
From: Gcc-patches <gcc-patches-
bounces+tamar.christina=arm....@gcc.gnu.org> On Behalf Of Martin Liška
Sent: Tuesday, June 29, 2021 11:09 AM
To: Joseph Myers <jos...@codesourcery.com>
Cc: GCC Development <g...@gcc.gnu.org>; gcc-patches@gcc.gnu.org
Subject: Re: [PATCH] Port GCC documentation to Sphinx
On 6/28/21 5:33 PM, Joseph Myers wrote:
Are formatted manuals (HTML, PDF, man, info) corresponding to this
patch version also available for review?
I've just uploaded them here:
https://splichal.eu/gccsphinx-final/
Thanks for doing this 😊
I'm a primary user of the PDFs (easier to work offline) I do like the look and
syntax highlighting of the new PDFs,
But I do prefer the way the current itemized entries are laid out.
See for instance ` vect_interleave` which before would have the description
indented on the next line, vs the new docs which puts it on the same line.
Very useful comment. Generally when I look at gccint documentation, majority of
documented "terms" are marked as @items in the Texinfo.
In Sphinx, we should rather use a proper concrete type, like:
:c:member:
:c:data:
:c:var:
:c:func:
:c:macro:
:c:struct:
:c:union:
:c:enum:
:c:enumerator:
:c:type:
These would improve the documentation when searching for something. I've got it
listed for after migration phase.
The visual break in my opinion makes it easier to read. It currently looks
like a sea of text. Also purely personal I expect, but could the weight of the
bold entries be reduced a bit? They look very BOLD to me atm and when there's a
lot of them I find it slightly harder to read.
That would be about a font selection for Latex, can you please experiment with:
https://www.sphinx-doc.org/en/master/latex.html#the-latex-elements-configuration-setting
?
Thanks,
Martin
Cheers,
Tamar
Martin
