Vertical Spacing between Docstring Categories

[michaelweinold]

(I hope I am opening this issue in the correct repository this time)

In a docstring with multiple (NumPy-style) sections, if one section ends in a table, no vertical space is left in the rendered docstring when using the readthedocs theme. The material theme does not seem to have the same issue:

"""
Fuel burn is calculated according to Table M.7 in the supplement to Seymour et al. (2020):

$$
    F=a_1 \cdot R^2 + a_2 \cdot R + c
$$

where:

| Symbol     | Dimension            | Description                                   |
|------------|----------------------|-----------------------------------------------|
| $F$        | [mass]               | Fuel required for the mission of the aircraft |
| $R$        | [distance]           | Range of the aircraft (=mission distance)     |
| $a_1$      | [mass/distance²]     | Regression coefficient for range squared      |
| $a_2$      | [mass/distance]      | Regression coefficient for range              |
| $c$        | [mass]               | Constant term                                 |

Warnings
--------
Note that the regression coefficients provided in Table M.7 of the Supplementary Information 
of Seymour et al. (2020) are not always consistent with the regression coefficients provided in the GitHub repository.
"""

• readthedocs theme:

• material theme:

[pawamoy]

Hi @michaelweinold, thanks for the report. Is your page deployed somewhere so we could inspect the HTML/CSS? It's probably more of an issue with mkdocstrings-python but lets keep the discussion here.

[michaelweinold]

Thank you for the swift reply. You can inspect the published documentation page here:
https://jetfuelburn.readthedocs.io/en/latest/api/reducedorder/#jetfuelburn.reducedorder.seymour_etal

[pawamoy]

Thanks! So it's really a readthedocs theme issue. Tables are simply not styled at all. I don't think mkdocstrings should deal with styling that isn't relevant to itself, so we will do it as last resort. I'd like to hear from maintainers of this theme first. In the meantime you can always style it yourself, to add a bottom margin to tables for example.