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

Broken documentation website #490

Open
Doublonmousse opened this issue Feb 5, 2024 · 1 comment
Open

Broken documentation website #490

Doublonmousse opened this issue Feb 5, 2024 · 1 comment

Comments

@Doublonmousse
Copy link
Contributor

Doublonmousse commented Feb 5, 2024

Describe the bug
Math formulaes are not rendered on the documentation website.

To Reproduce
Load the documentation website and look at some docstrings that contain math (like property dynamics of DMDBase)

Expected behavior
Math formulas are rendered on the documentation website (either as an image, a svg file or using mathjax/KaTeX).
Screenshot 2024-02-05 at 14 02 37
(obtained running the sphinx-build command locally)

Output
Pure text.

Screenshot 2024-02-05 at 14 01 56

Additional context
Rendering the website locally using a recent sphinx/python version (with sphinx installed from mamba) renders the website just fine and the conf.py and .bat has not recently been changed, so there is something wrong with how the documentation website is built (outdated Makefile / make.bat used or very outdated versions of sphinx, maybe? )

@ndem0
Copy link
Member

ndem0 commented Feb 7, 2024

Dear @Doublonmousse, many thanks for highlighting the issue!
We are planning to refresh the documentation in the future, so for sure we'll fix also such equations!

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

No branches or pull requests

2 participants