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

Feature/documentation #4

Merged
merged 9 commits into from
Apr 11, 2023
Merged

Feature/documentation #4

merged 9 commits into from
Apr 11, 2023

Conversation

lukavdplas
Copy link
Contributor

@lukavdplas lukavdplas commented Feb 28, 2023

Add documentation using mkdocs (part of #3). Aside from the 'getting started' instructions, this just renders the python docstrings. We should probably think about adding a more comprehensive guide at some point, though the docstrings are quite extensive already (kudos!).

This should make the repository ready for readthedocs once we make it public.

@lukavdplas lukavdplas merged commit dd40181 into develop Apr 11, 2023
@lukavdplas lukavdplas deleted the feature/documentation branch April 11, 2023 09:03
@lukavdplas lukavdplas restored the feature/documentation branch May 4, 2023 09:24
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 this pull request may close these issues.

2 participants