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

Implement automatic documentation generation using, e.g., Sphinx #68

Open
matteoettam09 opened this issue Sep 18, 2024 · 0 comments
Open
Assignees

Comments

@matteoettam09
Copy link
Contributor

matteoettam09 commented Sep 18, 2024

It makes sense to have automatic docs generation. Use the design.md to inform docs of functions and be deprecated, as currently docs are either in the alkahest docs or in the codebase.

Together with this, a less-code API-based documentation shall be generated using gitbook, see as a nice example:
https://docs.zama.ai/concrete-ml
https://github.com/zama-ai/concrete-ml/tree/main/docs

Section https://docs.zama.ai/concrete-ml/references/api
is populated using https://github.com/ml-tooling/lazydocs
Sklearn docs is based on sphinx.

@matteoettam09 matteoettam09 self-assigned this Sep 26, 2024
@matteoettam09 matteoettam09 changed the title Implement automatic documentation generation using Sphinx Implement automatic documentation generation using, e.g., Sphinx Oct 6, 2024
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

1 participant