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.

Sign up for GitHub

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

Jump to bottom

Auto-generate API reference #1

Closed

alexhroom opened this issue Aug 2, 2024 · 0 comments · Fixed by #25

Assignees

Collaborator

alexhroom commented Aug 2, 2024 •

edited

Loading

The API reference in both Python and MATLAB can be auto-generated from function docstrings: see
https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html for python
https://github.com/sphinx-contrib/matlabdomain for matlab

This should be done so that the API doc does not become out of date (and to save dev time writing it)

alexhroom mentioned this issue

Rewrite docstrings to facilitate API reference generation RascalSoftware/RAT#254

Open

alexhroom self-assigned this

alexhroom mentioned this issue

Adds python API reference #25

Merged

alexhroom closed this as completed in #25

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment