search

flatsurf / surface-dynamics

Teichmüller dynamics in SageMath
https://flatsurf.github.io/surface-dynamics/
GNU General Public License v2.0
11 stars 13 forks source link

Create documentation in CI and publish on github.io #29

Closed saraedum closed 3 years ago

saraedum commented 3 years ago

There is now this doctest failure:

sage -t --long --random-seed=0 /usr/share/miniconda/envs/test/lib/python3.9/site-packages/surface_dynamics/interval_exchanges/labelled.py
**********************************************************************
File "/usr/share/miniconda/envs/test/lib/python3.9/site-packages/surface_dynamics/interval_exchanges/labelled.py", line 1119, in surface_dynamics.interval_exchanges.labelled.LabelledPermutationLI.?
Failed example:
    sum(_) # abs tol .08
Expected:
    1.5725
Got:
    1.7135713394142524
Tolerance exceeded:
    1.5725 vs 1.7135713394142524, tolerance 2e-1 > 8e-2
videlec commented 3 years ago

There is now this doctest failure:

sage -t --long --random-seed=0 /usr/share/miniconda/envs/test/lib/python3.9/site-packages/surface_dynamics/interval_exchanges/labelled.py
**********************************************************************
File "/usr/share/miniconda/envs/test/lib/python3.9/site-packages/surface_dynamics/interval_exchanges/labelled.py", line 1119, in surface_dynamics.interval_exchanges.labelled.LabelledPermutationLI.?
Failed example:
    sum(_) # abs tol .08
Expected:
    1.5725
Got:
    1.7135713394142524
Tolerance exceeded:
    1.5725 vs 1.7135713394142524, tolerance 2e-1 > 8e-2

These are annoying random precision issues. The code is a kind of Monte-Carlo algorithm and the output is random (in particular there is no guarantee on the precision).

saraedum commented 3 years ago

There's a broken link in the docs:

URL        `http://www.labri.fr/perso/vdelecro/flatsurf.html'
Name       `http://www.labri.fr/perso/vdelecro/flatsurf.html'
Parent URL http://localhost:8880/surface_dynamics/, line 192, col 24
Real URL   http://www.labri.fr/perso/vdelecro/flatsurf.html
Check time 104.301 seconds
Size       257B
Result     Error: ReadTimeout: HTTPSConnectionPool(host='www.labri.fr', port=443): Read timed out. (read timeout=60)
saraedum commented 3 years ago

@videlec I think that I am essentially done here.

saraedum commented 3 years ago

(There are errors that still need to be fixed, in particular all the ? in the diff that could not be resolved by sphinx.)

saraedum commented 3 years ago 
URL        `http://perso.univ-rennes1.fr/anton.zorich/Software/software_en.html'
Name       `http://perso.univ-rennes1.fr/anton.zorich/Software/software_en.html'
Parent URL http://localhost:8880/surface_dynamics/references.html, line 243, col 2
Real URL   https://perso.univ-rennes1.fr/anton.zorich/Software/software_en.html
Check time 3.460 seconds
Size       1KB
Info       Redirected to
           `https://perso.univ-rennes1.fr/anton.zorich/Software/software_en.html'.
Result     Error: 404 Not Found
videlec commented 3 years ago

The CI ended with

/usr/share/miniconda/envs/test/lib/python3.9/site-packages/surface_dynamics/misc/constellation.py:docstring of surface_dynamics.misc.constellation.Constellation_class:1:py:class reference target not found: sage.structure.element.Element

that I can not reproduce on the conda environment created from environment.yml...

videlec commented 3 years ago

Also, because I use a @cached_method decorator from sage I got the following warning

docstring of surface_dynamics.flat_surfaces.origamis.origami_dense.Origami_dense_pyx.teichmueller_curve:88: WARNING: Unknown interpreted text role "trac".

Should I properly copy the trac role define inside sage?