math1um / objects-invariants-properties

Objects, Invariants and Properties for Graph Theory (GT) automated conjecturing: in particular with the Sage program CONJECTURING: http://nvcleemp.github.io/conjecturing/
GNU General Public License v3.0
14 stars 6 forks source link

Better Documentation? #654

Open math1um opened 1 year ago

math1um commented 1 year ago

A grad student suggests:

Constructing some useful documentation. Currently (to my knowledge) one has to search gt.sage for function definitions, but I'd love to live in a world where there is searchable documentation: for each function in gt.sage it contains the name, description (input/output, with support for displaying LaTeX, like mathjax),an example (several if necessary), and references (with hyperlinks to where one can access the article, if possible.) I imagine this would be hosted online in a git repo or something, but made easily exportable to an offline version.

Can we make nice documentation like what exists for graph theory in SageMath? See, for example:

https://doc.sagemath.org/html/en/reference/graphs/index.html