-
Notifications
You must be signed in to change notification settings - Fork 3
Generate API documentation #11
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
Comments
hkabbech
added a commit
that referenced
this issue
Feb 16, 2024
hkabbech
added a commit
that referenced
this issue
Feb 16, 2024
hkabbech
added a commit
that referenced
this issue
Feb 17, 2024
hkabbech
added a commit
that referenced
this issue
Feb 26, 2024
An API documentation containing the main purposes, instructions, module docstrings and the contribution guideline is now available at the following address: https://tracksegnet.readthedocs.io/en/latest/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
For using the functionality of this repository in other projects, it is essential to have some API documentation accessible. Most of the methods have docstrings, so usage within an IDE is fine.
For better accessibility, I suggest also rendering a documentation website, using readthedocs and GitHub actions, for example.
The text was updated successfully, but these errors were encountered: