Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

White underline visible in documentation code blocks due to Sphinx Theme #750

Open
polyzen opened this issue Mar 1, 2023 · 9 comments
Open

Comments

@polyzen
Copy link
Contributor

polyzen commented Mar 1, 2023

I see the docs are generated with quite an old version of Sphinx, maybe this has been fixed since then. If so, code blocks should probably all be made to use .. code-block.

@thp
Copy link
Owner

thp commented Apr 11, 2023

You mean the docs on https://urlwatch.readthedocs.io/en/latest/ or the ones that one can build locally?

@polyzen
Copy link
Contributor Author

polyzen commented Apr 11, 2023

The deployed docs

@polyzen
Copy link
Contributor Author

polyzen commented Apr 11, 2023

@thp
Copy link
Owner

thp commented Apr 11, 2023

Looks okay from here:

image

With this source:

.. code-block:: yaml

   url: http://example.com/longlines.html
   filter:
     - html2text:
         method: lynx
         width: 400

Which browser/settings are you using?

@thp
Copy link
Owner

thp commented Apr 11, 2023

Or do you mean the whitespace underline?

This could be a pygments/theme:

If this is the issue, maybe filing a bug over at https://github.com/readthedocs/readthedocs.org/issues might be the way to go?

@thp
Copy link
Owner

thp commented Apr 11, 2023

One thing that might help is going with a newer Ubuntu and Python version, tried this here: 07e000f

@polyzen
Copy link
Contributor Author

polyzen commented Apr 11, 2023

Not sure, but newer Ubuntu might still be on the same Sphinx version :p Tested on latest Sphinx, but the issue was still there.

sphinx-doc/alabaster#188 fixed the issue, rebased and created a new PR: sphinx-doc/alabaster#202

@thp
Copy link
Owner

thp commented Apr 12, 2023

Not sure if https://github.com/readthedocs/sphinx_rtd_theme also needs to be updated?

@thp thp changed the title .. code-block seems to not be rendering properly White underline visible in documentation code blocks due to Sphinx Theme Apr 12, 2023
@polyzen
Copy link
Contributor Author

polyzen commented Apr 13, 2023

Not sure if https://github.com/readthedocs/sphinx_rtd_theme also needs to be updated?

Haven't checked yet. If you're considering changing themes, Furo is also quite nice and well maintained.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants