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

Add the API documentation #175

Open
Tracked by #170
dalonsoa opened this issue Dec 20, 2024 · 0 comments
Open
Tracked by #170

Add the API documentation #175

dalonsoa opened this issue Dec 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@dalonsoa
Copy link
Collaborator

dalonsoa commented Dec 20, 2024

Add the automatic generation and deployment of the API.

As part of this issue, sections of the docstrings that are poorly documented or with bad formatting in the API docs should be flagged and addressed - possibly in separate PR.

@dalonsoa dalonsoa added the documentation Improvements or additions to documentation label Dec 20, 2024
@dalonsoa dalonsoa added this to the v1.0.0 milestone Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant