-
Notifications
You must be signed in to change notification settings - Fork 4
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
API documentation #8
Comments
Thanks for pointing that out! The documentation for the python API is now available at https://paulst.github.io/NGSTrefftz/ |
@PaulSt, This page has rendering issues: https://paulst.github.io/NGSTrefftz/notebooks/embTrefftz.html |
@PaulSt I thing that the website https://paulst.github.io/NGSTrefftz shall be referenced in the README.md which is displayed when looking at github repository of the project. |
@thelfer done! |
This issue is created as part of the review of the JOSS paper (openjournals/joss-reviews#4135).
JOSS review criteria imply judging the API documentation (https://joss.readthedocs.io/en/latest/review_criteria.html).
If I am not mistaken, I only saw tutorials, but no pages describing the API.
The text was updated successfully, but these errors were encountered: