PyDMD icon indicating copy to clipboard operation
PyDMD copied to clipboard

Broken documentation website

Open Doublonmousse opened this issue 1 year ago • 1 comments

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? )

Doublonmousse avatar Feb 05 '24 13:02 Doublonmousse

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!

ndem0 avatar Feb 07 '24 10:02 ndem0