View Issue Details

IDProjectCategoryView StatusLast Update
0009146Talerdocumentationpublic2024-11-03 14:41
Reporterwillow Assigned Tooec  
PrioritynormalSeveritymajorReproducibilityalways
Status resolvedResolutionfixed 
Fixed in Versiongit (master) 
Summary0009146: HTML documentation does not render mathematics properly
DescriptionThe page at https://docs.taler.net/design-documents/024-age-restriction.html contains lots of rendered mathematic expressions, in the sense that the LaTeX source code is literally being rendered to an image, with no attempt made to typeset it.

As one can imagine, this makes the document rather difficult to understand. In fact, it's worse than no processing at all, as then at least one could select the text.

Presumably sphinx.ext.imgmath isn't set up properly, though I suggest using KaTeX or MathJax as their results carry greater semantic meaning in the HTML output.
TagsNo tags attached.

Activities

Stefan

2024-09-02 21:55

developer   ~0023140

Hah, I noticed in a MM channel that Oec is solving his sphinx configuration today, so this might be the soluton of this bug, too. Let's investigate a bit further...

Stefan

2024-09-09 13:28

developer   ~0023215

Dear Oec, did you manage to set up your Sphinx configuration lately? Here is a Mantis ticket that deals with an implementation of rendering mathematical expressions with Sphinx on the documentation page for age restrictions (https://docs.taler.net/design-documents/024-age-restriction.html).

To be frank, I cannot see any badly rendered equations on said page. Thank you for caring, @oec!
Cheers, S.

oec

2024-09-09 13:50

developer   ~0023217

Mhh, math/LaTeX rendering seems to be disabled now on docs.taler.net. Instead, the LaTeX commands are shown verbatim.
This is a slight improvement over the broken rendering.
However, I have not done any work on this, yet, will look into it.

Stefan

2024-09-09 13:57

developer   ~0023218

If you think that the verbatim equations are well aligned with your own requirements, you can leave the HTML page as is. The cited paper "Zero Knowledge Age Restriction for GNU Taler" shows nicely rendered equations and should suffice (to my eyes and requirements), although it is available only at Springer.

oec

2024-09-09 14:03

developer   ~0023219

No, the current state is not acceptable, IMHO. I will try configuration changes _or_ re-writing the mathematical statements in pure text, without referring to LaTeX.

oec

2024-11-03 14:41

developer   ~0023640

With a workaround for the build system, introduced in commit c4b3ca20cbe45b42927755e8e8c6dba10424dbec, the images (now svg's) for the formulas are visisable again.

Issue History

Date Modified Username Field Change
2024-08-29 19:12 willow New Issue
2024-08-29 19:12 willow Status new => assigned
2024-08-29 19:12 willow Assigned To => Stefan
2024-09-02 21:55 Stefan Note Added: 0023140
2024-09-09 13:28 Stefan Note Added: 0023215
2024-09-09 13:28 Stefan Assigned To Stefan => oec
2024-09-09 13:50 oec Note Added: 0023217
2024-09-09 13:57 Stefan Note Added: 0023218
2024-09-09 14:03 oec Note Added: 0023219
2024-11-03 14:41 oec Status assigned => resolved
2024-11-03 14:41 oec Resolution open => fixed
2024-11-03 14:41 oec Fixed in Version => git (master)
2024-11-03 14:41 oec Note Added: 0023640