Bug in Table Headers sphinx_rtd_theme

[Dirk Baumbach]

Hello,

i have this weird issue, an additional newline is added in every header cell of a table:

The Code:

.. list-table::

   :header-rows: 1

   :align: left

   * - Inport

     - OutDataTypeStr

     - OutMin

     - OutMax

     - PortDimensions

     - SampleTime

     - SignalType

     - Description

   * - u1

     - Inherit: auto

     - []

     - []

     - -1

     - -1

     - real

     - This is the dividend.

   * - u2

     - Inherit: auto

     - []

     - []

     - -1

     - -1

     - real

     - This is the divisor.

It doesn't matter with which directive the table was created. It happens with all types (simple table, list-table, csv-table, ...). I know this must be a bug, because all example rtd-documentations don't have this issue:

https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/lists_tables.html#list-tables

http://mbless.de/blog/2015/06/16/files/demo_docs/index.html#giant-tables

I'm using the latest versions of both sphinx and the rtd-theme

I didn't found anything like this on google so far.

Does anyone have experience with this issue?

Sincerly

Dirk

[Libor Jelinek]

Hello Dirk!

I've also noticed that my tables header rows got taller. But it's not related to RTD theme. If you look at generated source code, Sphinx inserts header in <p> that has margin-bottom: 24px:

For example old Sphinx 1.8.1 from Sep 2, 2018 doesn't wrap headers in <p>. Docs you posted as example must be built with such old Sphinx. Current version current 2.3.1. inserts <p>. Don't ask me why.

Workaround if it's critical, use styles to remove margins for <p> inside <th>.

Libor

po 6. 1. 2020 v 11:28 odesílatel 'Dirk Baumbach' via sphinx-users <sphinx...@googlegroups.com> napsal:

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/c591b21e-c36b-41e3-a601-8443980e571b%40googlegroups.com.

[Dirk Baumbach]

Thanks for this plausible answer!

I am not very familiar with CSS. Do you have a sample code snippet on how to remove the <p> margin in the table header tag?

[Libor Jelinek]

My pleasure! There is multiple ways. If you don't already have own CSS, create one.

1. In your conf.py add line

   html_css_files = ['custom.css']

2. Create "custom.css" inside static dir (usually "_static" but setting html_static_path can change static dir name) with the content:

   th.head p {
      margin: 0;
   }

po 6. 1. 2020 v 13:55 odesílatel 'Dirk Baumbach' via sphinx-users <sphinx...@googlegroups.com> napsal:

Thanks for this plausible answer!

I am not very familiar with CSS. Do you have a sample code snippet on how to remove the <p> margin in the table header tag?

--

You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/01b9d949-0366-4d9f-a5fc-68a94af16c36%40googlegroups.com.

[Komiya Takeshi]

Hi Dirk,

Since Sphinx-2.0, the default HTML writer has been changed to HTML5 writer. It inserts <p> tag to some location. I guess sphinx_rtd_theme does not work well with HTML5 writer. As a workaround, you can use old HTML4 writer with `html4_writer = True` setting in your conf.py. If possible, please report this into sphinx_rtd_theme project. I hope it will support HTML5 writer.

Thanks,

Takeshi KOMIYA

2020年1月6日(月) 21:14 Libor Jelinek <ljel...@virtage.com>:

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAB-x1GK_eVtsPtqbgfWet-NH2d4g-r7vQX8fYi2QdL3QnUq%3D7Q%40mail.gmail.com.

[Jared Dillard]

There is a project board on github to fix the issues with sphinx 2 and the RTD theme: https://github.com/readthedocs/sphinx_rtd_theme/projects/1

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAFmkQAM-9%3Di-bh7ueV0yi8F_W7hgvcmOKv4MUEaqOfarGitqbg%40mail.gmail.com.

[Komiya Takeshi]

Good to hear!

2020年1月7日(火) 5:51 Jared Dillard <jared....@gmail.com>:

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAHoez_k_YmHEj60jAXK%3Drz6vUnZ-3f%3D4q1edcmdvWHce0r9cvQ%40mail.gmail.com.

[Libor Jelinek]

I'm sorry but I still see it as a bug of HTML5 writer, themes may only workaround it with CSS. No human will code with extra <p> as in generated output (<th><p>Column heading</p></th>). Should that be reported rather to Docutils / Sphinx (not sure who supply HTML5 writer)?

Libor

út 7. 1. 2020 v 17:11 odesílatel Komiya Takeshi <i.tk...@gmail.com> napsal:

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAFmkQAPwVCaqO5XnV-Ma6BArn2umi0FbjoVtbtvm%3Do91bex42A%40mail.gmail.com.

[Komiya Takeshi]

Hi,

This behavior comes from docutils' implementation. So it would be better to post opinions to docutils-sig.

IMO, this is not a bug. In reST syntax, we can put one or more paragraphs in table header. To supports each case consistently, docutils always generates paragraph tag in HTML5 mode. So far, in HTML4 mode, it strips paragraph tag in case of table header contains only one paragraph node. But it is a bit difficult to add styles in CSS to me. +1 for current behavior.

2020年1月8日(水) 21:32 Libor Jelinek <ljel...@virtage.com>:

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAB-x1G%2BtQm8Geh3TFBgikDUDNwbD_imTA6swfvprwFihfwtrfg%40mail.gmail.com.

[Libor Jelinek]

Writer used in Sphinx >= 2 by default is this one https://docutils.sourceforge.io/docs/user/html.html#html5-polyglot?

st 8. 1. 2020 v 14:52 odesílatel Komiya Takeshi <i.tk...@gmail.com> napsal:

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOMVb6Xo5oXr5t%3DS2Ey6mP8JidHiJ11N7EAKhUh1Yw75Q%40mail.gmail.com.

[Komiya Takeshi]

Correctly, Sphinx's HTML5 writer inherits html5-polyglot writer. It adds original features. But we does not modify about paragraphs into html5-polyglot. So almost yes.

2020年1月8日(水) 23:15 Libor Jelinek <ljel...@virtage.com>:

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAB-x1GLQTZ0VbX-gQ4asV4SOFqjVmBqhFRgd%2BjMo9nKPhUvi7w%40mail.gmail.com.