Skip to content

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

Closed
imagejan opened this issue Feb 8, 2024 · 1 comment
Closed

Generate API documentation #11

imagejan opened this issue Feb 8, 2024 · 1 comment

Comments

@imagejan
Copy link

imagejan commented Feb 8, 2024

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.

@hkabbech
Copy link
Owner

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/
For each pull request, an updated documentation is generated through a GitHub action

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