tachyon syntax error when building doc

[jfraymond]

When building the documentation on a system

• whose locale uses commas as a decimal separator (in the tested case LC_NUMERIC="fr_FR.UTF-8"); and
• where jmol is not available (for instance if java is not installed),

tachyon, which is used to produced images of 3d objects for the documentation when jmol is not available, returns a syntax error. The error is caused by the presence of float numbers with commas (instead of dots) in the input string of tachyon. Curiously this bug seems to only happen when building the doc. See https://groups.google.com/forum/#!topic/sage-devel/peTGEjzS2eA .

This ticket fixes the bug by setting the locale before producing plots for the documentation.

Component: documentation

Keywords: tachyon syntax error locale documentation

Author: Jean-Florent Raymond

Branch/Commit: 31beb0e

Reviewer: Peter Bruin

Issue created by migration from https://trac.sagemath.org/ticket/28971

[jfraymond]

Branch: /u/gh-jfraymond/locale-when-building-doc

[jfraymond]

Commit: e06dffc

[jfraymond]

Author: Jean-Florent Raymond

[Konrad127123]

comment:4

Could this have issues if the en_US.UTF-8 locale is unavailable? Would it be better to set LC_ALL=C?

[jfraymond]

comment:5

Yes, you are right.
I fixed it in a new commit (I set LC_NUMERIC to 'C'). No problem building the documentation on my system after this change.

---

New commits:

31beb0e

Set LC_NUMERIC locale to 'C' before producing plots for the doc

[jfraymond]

Changed commit from e06dffc to 31beb0e

[embray]

comment:6

Can this problem be reproduced outside the doc build? Or is it a more general problem? I think it seems strange to try to fix this just in the doc build.

[embray]

comment:7

Replying to @embray:

Can this problem be reproduced outside the doc build? Or is it a more general problem? I think it seems strange to try to fix this just in the doc build.

Answering my own question: I can't seem to reproduce the problem outside the docbuild, even after confirming that I have os.environ['LC_NUMERIC'] == 'fr_FR.UTF-8'. The question though is why?

[jfraymond]

comment:8

I did not manage to reproduce it outside of the doc build. When I execute in sage exactly the same commands as those used to produce plots for the doc, no problem occurs.

[pjbruin]

comment:9

I got this error while building the documentation (using the locale nl_NL.utf8; Dutch also uses commas as decimal separator) and this ticket fixes it.

[pjbruin]

Reviewer: Peter Bruin

[vbraun]

Changed branch from /u/gh-jfraymond/locale-when-building-doc to u/gh-jfraymond/locale-when-building-doc

[vbraun]

Changed branch from u/gh-jfraymond/locale-when-building-doc to 31beb0e