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

Publish API documentation #170

Open
deprit opened this issue Aug 17, 2024 · 0 comments
Open

Publish API documentation #170

deprit opened this issue Aug 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@deprit
Copy link
Collaborator

deprit commented Aug 17, 2024

Armory Library needs auto-generated API documentation that can be easily consulted by an ML engineer developing ML model evaulations in Armory Library. This will require the steps below.

  • Revising Python docstrings to meet Sphinx requirements (e.g. parameter types)
  • Add Sphinx documentation build to CI actions
  • Publish the API docs to readthedocs
@deprit deprit added the documentation Improvements or additions to documentation label Aug 17, 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