MrDogeBro / sphinx_rtd_dark_mode

Adds a toggleable dark mode to the Read the Docs theme for Sphinx.
sphinx-rtd-dark-mode.vercel.app
MIT License
49 stars 15 forks source link

Add Spacing Between Docstring Header and Text #21

Open Zethson opened 3 years ago

Zethson commented 3 years ago

Hi,

sorry, more reports by me :) I have a list in a docstring whose header gets not nicely rendered. There's a light bar that I think should not be there (just before "Available").

image

Link to example: https://sc-toolbox.readthedocs.io/en/latest/usage.html#sc_toolbox.api.plot.Colormaps

Docstring:

class Colormaps(Enum):
    """
    Available colormaps:
        | grey_red
        | grey_blue
        | grey_green
        | gray_yellow
        | grey_violet
    """

Thank you very much.

MrDogeBro commented 3 years ago

@Zethson, just wanted to start off by saying thanks for all of your help in picking out bugs in the project so far. However, that is not a bug of the dark theme. If you switch to light theme, you will find the same thing happens the the light theme built into Sphinx RTD theme. Please, in the future, check what the light theme looks like before reporting a bug to make sure it is actually a bug of the dark theme and not just a part of the Sphinx RTD theme. Thanks!

Screen Shot 2021-06-13 at 12 47 10 PM

Zethson commented 3 years ago

Sorry and thanks. You are correct. Nevertheless, don't you think that if you patched that it would be an improvement? It might then not be a one to one correspondence to the original light theme, but it really annoys my eyes. Maybe an option again?

MrDogeBro commented 3 years ago

Possibly — again it would be low on the priority right now though but possibly down the line.