Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better Documentation? #654

Open
math1um opened this issue Nov 14, 2022 · 0 comments
Open

Better Documentation? #654

math1um opened this issue Nov 14, 2022 · 0 comments

Comments

@math1um
Copy link
Owner

math1um commented Nov 14, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant