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

API documentation #8

Closed
thelfer opened this issue Mar 1, 2022 · 4 comments
Closed

API documentation #8

thelfer opened this issue Mar 1, 2022 · 4 comments

Comments

@thelfer
Copy link

thelfer commented Mar 1, 2022

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.

@PaulSt
Copy link
Owner

PaulSt commented Mar 6, 2022

Thanks for pointing that out! The documentation for the python API is now available at https://paulst.github.io/NGSTrefftz/

@PaulSt PaulSt closed this as completed Mar 6, 2022
@thelfer
Copy link
Author

thelfer commented Mar 9, 2022

@PaulSt, This page has rendering issues: https://paulst.github.io/NGSTrefftz/notebooks/embTrefftz.html

@thelfer
Copy link
Author

thelfer commented Mar 9, 2022

@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.

@PaulSt
Copy link
Owner

PaulSt commented Mar 12, 2022

@thelfer done!

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

2 participants