thp / urlwatch

Watch (parts of) webpages and get notified when something changes via e-mail, on your phone or via other means. Highly configurable.
https://thp.io/2008/urlwatch/
Other
2.81k stars 352 forks source link

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

Open polyzen opened 1 year ago

polyzen commented 1 year ago

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 commented 1 year ago

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

polyzen commented 1 year ago

The deployed docs

polyzen commented 1 year ago

eg. https://urlwatch.readthedocs.io/en/latest/advanced.html#setting-the-content-width-for-html2text-lynx-method

thp commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

One thing that might help is going with a newer Ubuntu and Python version, tried this here: https://github.com/thp/urlwatch/commit/07e000f5f9989442b707ec35a0d8ee347b996bfe

polyzen commented 1 year ago

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

https://github.com/sphinx-doc/alabaster/pull/188 fixed the issue, rebased and created a new PR: https://github.com/sphinx-doc/alabaster/pull/202

thp commented 1 year ago

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

polyzen commented 1 year ago

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.