Update documentation - Githubissues

IMSY-DKFZ / simpa

The Simulation and Image Processing for Photoacoustic Imaging (SIMPA) toolkit.

https://simpa.readthedocs.io/en/main/

Other

65 stars 17 forks source link

Update documentation #308

Closed jnoelke closed 3 days ago

jnoelke commented 5 days ago

Please check the following before creating the pull request (PR):

[ ] Did you run automatic tests?
[ ] Did you run manual tests?
[x] Is the code provided in the PR still backwards compatible to previous SIMPA versions?

List any specific code review questions

List any special testing requirements

Additional context (e.g. papers, documentation, blog posts, ...) Adds to the original pull request #296

Provide issue / feature request fixed by this PR

Fixes #294

kdreher commented 5 days ago

This should probably not be its own PR but rather done everytime something in the documentation changes. One option could be to add a pre-commit hook that automatically builds the documentation

jnoelke commented 4 days ago

As an alternative, it could also be implemented as a github action