webbpsf icon indicating copy to clipboard operation
webbpsf copied to clipboard

minor: docs rendering issue

Open mperrin opened this issue 2 years ago • 2 comments

Something changed in the CSS or other style display for the documentation, such that bullet point lists no longer show any bullet symbols. For instance see https://webbpsf.readthedocs.io/en/latest/relnotes.html

This is just cosmetic but it does seem to make it harder to read.

mperrin avatar Sep 17 '22 02:09 mperrin

I believe this is because of a problem with the stsci_rtd_theme package that's used to control CSS settings. jwst's docs have ~the same issue~ (updated link).

I reported this issue at spacetelescope/stsci_rtd_theme#19 and proposed a fix at spacetelescope/stsci_rtd_theme#20, but I'm not sure what the turnaround time is for a review. A temporary solution is to manually replace each * with a bullet character (\•), but it's tedious.

ojustino avatar Sep 22 '22 00:09 ojustino

The maintainers of stsci_rtd_themeaccepted the fix in spacetelescope/stsci_rtd_theme#20 several months ago. They haven't done another release since the PR was merged, so we may need to specifically install the version on main in order for the webbpsf docs to render properly again.

ojustino avatar Aug 14 '23 21:08 ojustino