flatsurf / sage-flatsurf

Flat surfaces in Sage
https://flatsurf.github.io/sage-flatsurf/
GNU General Public License v2.0
10 stars 10 forks source link

Check for broken references in the documentation #209

Closed saraedum closed 1 year ago

saraedum commented 1 year ago

This makes the CI fail when there are invalid references in the documentation. (I added a lot of those in #158.)

Checklist

saraedum commented 1 year ago

This is a bunch of rather bizarre ones @videlec:

/usr/share/miniconda3/envs/test/lib/python3.10/site-packages/flatsurf/geometry/finitely_generated_matrix_group.py:docstring of flatsurf.geometry.finitely_generated_matrix_group:2:py:class reference target not found: EmptySetError

If you grep for EmptySetError it's nowhere to be found. Apparently, we now inherit doc strings in sphinx and EmptySetError is in Parent.an_element, see https://flatsurf.github.io/sage-flatsurf/geometry/finitely_generated_matrix_group.html#flatsurf.geometry.finitely_generated_matrix_group.FinitelyGenerated2x2MatrixGroup.an_element.

So we need to add a few docstrings to our code to make these warnings go away.

github-actions[bot] commented 1 year ago

Documentation preview for this PR is ready! :tada: Built with commit: 223121b61f6274e35e78254d10724fbfc56db5cf