Re: [PATCH v4 0/3] improve get_feat.pl output when all features are displayed

From: Mauro Carvalho Chehab
Date: Mon Dec 07 2020 - 04:34:28 EST


Em Sat, 5 Dec 2020 17:03:50 +0100
Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> escreveu:

> Em Fri, 4 Dec 2020 14:48:43 -0700
> Jonathan Corbet <corbet@xxxxxxx> escreveu:
>
> > On Fri, 4 Dec 2020 16:32:27 +0100
> > Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> wrote:
> >
> > > As requested, those patches improve the output of the script, when all features
> > > are displayed.
> > >
> > > The first patch was already posted as-is at v3.
> > >
> > > Patch 2 is optional. IMO, it makes more sense for the admin guide to show
> > > the architectures where the features are OK, then TODO, and finally the
> > > ones that are incompatible with the features. I already sent it together
> > > with a comment.
> > >
> > > Patch 3 is new: it tries to reduce the width of the table, in order for it
> > > to better fit on a terminal. With the patch, the number of columns were
> > > reduced, in order to better fit at console output. Before the patch, the
> > > output takes 281 lines with 158 columns (total size: 38.9 kB).
> > > After the patch, displaying all features require 439 lines and 92 columns
> > > (total size: 37.6 kB).
> >
> > OK, this is much improved, thanks; applied.
>
> Anytime.
>
> >
> > The one last thing I would do is stick "valign=top" on all the table
> > entries, but we can leave the shed a different color for now :)
>
> I actually prefer myself valign=center on tables ;-)
>
> In any case, a change like that should be simple to do.
>
> either adjust:
>
> Documentation/sphinx-static/theme_overrides.css
>
> to change it globally for all tables or create a "table_valign_top" CSS
> class on it, changing the script to add:
>
> .. cssclass:: table_valign_top
>
> Before each table.

Btw, if you want to play with changing the table alignment, the
enclosed patch changes the alignment to use valign=top for all
tables (and not only for the feature ones).

Don't forget to remove the old theme before testing the
patch with:

$ rm $(find Documentation/output/ -name theme_overrides.css)

As sphinx (at least version 2.4.4) only writes it if the file
doesn't exist.

Thanks,
Mauro

[PATCH] docs: use top-alignment for table cells

Change the table's default in order to align cells on the top,
overriding the defaults found on Read the Docs Sphinx Theme.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>

diff --git a/Documentation/sphinx-static/theme_overrides.css b/Documentation/sphinx-static/theme_overrides.css
index 459ec5b29d68..e850859e35a0 100644
--- a/Documentation/sphinx-static/theme_overrides.css
+++ b/Documentation/sphinx-static/theme_overrides.css
@@ -42,6 +42,11 @@ p {
font-size: 100%;
}

+/* use vertical alignment on tables */
+.rst-content table.docutils td, .rst-content table.field-list td, .wy-table td {
+ vertical-align: top;
+}
+
/* Interim: Code-blocks with line nos - lines and line numbers don't line up.
* see: https://github.com/rtfd/sphinx_rtd_theme/issues/419
*/