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

Documentation #25

Closed
haesleinhuepf opened this issue Nov 16, 2021 · 1 comment · Fixed by #26
Closed

Documentation #25

haesleinhuepf opened this issue Nov 16, 2021 · 1 comment · Fixed by #26

Comments

@haesleinhuepf
Copy link
Member

haesleinhuepf commented Nov 16, 2021

We should create a minimal documentation. E.g. the readme should say what this library is doing and list all functions that are publicly available. Links to notebooks for more details would be great as well. See the pyclesperanto example gallery for an example of how this could be done without much effort. In the future, we should not merge new functions without the new function being linked in the documentation.

@jo-mueller
Copy link
Contributor

Hi @haesleinhuepf ,

I am currently working on documentation pages here and I am fairly content with how it is coming out. The documentation pages can be found at _doc/_build/html/index.html.

Afaik, these fies could be copied relatively easily to readthedocs.io. I moved the notebooks to the doc part for this purpose.

Let me know what you think!

@jo-mueller jo-mueller mentioned this issue Nov 29, 2021
9 tasks
@jo-mueller jo-mueller linked a pull request Nov 29, 2021 that will close this issue
9 tasks
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

Successfully merging a pull request may close this issue.

2 participants