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

minor: docs rendering issue #583

Open
mperrin opened this issue Sep 17, 2022 · 2 comments
Open

minor: docs rendering issue #583

mperrin opened this issue Sep 17, 2022 · 2 comments
Labels
bug Something isn't working docs

Comments

@mperrin
Copy link
Collaborator

mperrin commented Sep 17, 2022

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 mperrin added bug Something isn't working docs labels Sep 17, 2022
@ojustino
Copy link
Collaborator

ojustino commented Sep 22, 2022

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
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs
Projects
None yet
Development

No branches or pull requests

2 participants