tskit-dev / tskit-site

tskit website
Other
0 stars 8 forks source link

highlighted section of source code is unreadable #173

Closed connor-french closed 11 months ago

connor-french commented 1 year ago

Hello all! I think the documentation site is fantastic and has helped me out quite a bit. Here's my issue:

There seems to be a problem with code highlighting when clicking on a [source] link for a particular function. The highlighted section in the source code turns pink and the underlying text is unreadable. I've attached a photo of what my screen looks like when I click [source] for the stepping_stone_model() function in the API References section.

Screen Shot 2023-03-27 at 2 40 01 PM

jeromekelleher commented 1 year ago

Thanks for the bug report @connor-french! Is there anything we can do about this @benjeffery, or is a known issue on the queue for the next batch of website tweaks?

benjeffery commented 1 year ago

This might be https://github.com/tskit-dev/tskit-site/issues/131 but I'd need to check. I'll add this to the milestone.

daikitag commented 1 year ago

I think this issue is already fixed in https://github.com/tskit-dev/tskit-book-theme/pull/5 but it is not uploaded to PyPI:

image

If I use tskit-book-theme in https://github.com/tskit-dev/tskit-book-theme locally on my computer, the highlighted section of source code looks perfectly fine. I think this issue will be easily solved if you could update the tskit-book-theme version in PyPI and recreate the website using the new tskit-book-theme.

image

benjeffery commented 1 year ago

Thanks for the prod @daikitag! I do need to push an updated version on the package - maybe we should fix #151 first though?

hyanwong commented 11 months ago

This is still a tiny bit garish on the newly updated site, but definitely readable, so I think we can close: Screenshot 2023-10-30 at 14 59 07

benjeffery commented 11 months ago

Garish yes, but also the default for the offical theme - so I'm tempted to live with it.