Documentation Fixes

[saraedum]

Checklist

• [x] Added an entry in doc/news/.
• [x] Added a test for this change. No, don't know what to test.
• [x] Added new .py files to the documentation in doc/geometry or doc/graphical. Nothing new.

[videlec]

Since it was compiled on the CI, is there a way to have a look at the documentation without compiling it on my machine?

[videlec]

I have some weird error messages when doing make html. The first two are due to the fact that I do not have pyflatsurf installed. I am not sure that qualifies as a bug (do we assume that pyflatsurf is installed when building the documentation?). The last three Could not lex literal_block as "ipythontb". Highlighting skipped. are more mysterious to me.

Reading sources... [100%] install                                              
.../sage-flatsurf/doc/examples/apisa_wright.md: WARNING: Executing notebook failed: CellExecutionError [mystnb.exec]
.../sage-flatsurf/doc/examples/apisa_wright.md: WARNING: Notebook exception traceback saved in: .../sage-flatsurf/doc/_build/html/reports/examples/apisa_wright.err.log [mystnb.exec]
.../sage-flatsurf/doc/examples/boshernitzan_conjecture.md: WARNING: Executing notebook failed: CellExecutionError [mystnb.exec]
.../sage-flatsurf/doc/examples/boshernitzan_conjecture.md: WARNING: Notebook exception traceback saved in: .../sage-flatsurf/doc/_build/html/reports/examples/boshernitzan_conjecture.err.log [mystnb.exec]
.../sage-flatsurf/doc/examples/siegel_veech.md: WARNING: Executing notebook failed: CellExecutionError [mystnb.exec]
.../sage-flatsurf/doc/examples/siegel_veech.md: WARNING: Notebook exception traceback saved in: .../flatsurf/sage-flatsurf/doc/_build/html/reports/examples/siegel_veech.err.log [mystnb.exec]
.../sage-flatsurf/flatsurf/geometry/surface_objects.py:docstring of flatsurf.geometry.surface_objects.Cylinder:6: CRITICAL: Unexpected section title.

To Do
-----
.../sage-flatsurf/flatsurf/geometry/surface_objects.py:docstring of flatsurf.geometry.surface_objects.Cylinder.plot:9: CRITICAL: Unexpected section title.

Parameters
----------
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] install                                               
.../sage-flatsurf/doc/examples/apisa_wright.md:109: WARNING: Could not lex literal_block as "ipythontb". Highlighting skipped.
.../sage-flatsurf/doc/examples/boshernitzan_conjecture.md:72: WARNING: Could not lex literal_block as "ipythontb". Highlighting skipped.
.../sage-flatsurf/doc/examples/siegel_veech.md:39: WARNING: Could not lex literal_block as "ipythontb". Highlighting skipped.

[saraedum]

Since it was compiled on the CI, is there a way to have a look at the documentation without compiling it on my machine?

I am adding a CI job that makes the documentation available. It's already available now as a download in the build-manual job. Let me try if I can also make a preview available like SageMath does now.

[saraedum]

I have some weird error messages when doing make html. The first two are due to the fact that I do not have pyflatsurf installed. I am not sure that qualifies as a bug (do we assume that pyflatsurf is installed when building the documentation?).

Yes, we expect all the optionals to be installed so we can compile all the notebooks.

The last three Could not lex literal_block as "ipythontb". Highlighting skipped. are more mysterious to me.

The highlighting for exception messages in notebooks is not working correctly it seems. (This is caused by the previous errors when rendering the notebooks.)

So, not really an issue but probably easy to fix anyway.

[saraedum]

Please have a look now @videlec .

Hm…why does the link go to the wrong place above…

Should be fixed now. Let's see what the next netlify deploy looks like.

[github-actions[bot]]

Documentation preview for this PR is ready! :tada: Built with commit: 45182c26ece67a5e966e5c0a0e00100463e46024

[videlec]

Looks good to me.