API documentation
thelfer opened this issue · comments
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.
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!