-
Notifications
You must be signed in to change notification settings - Fork 19
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
User Guide and API documentation #412
Comments
I think Material for MkDocs is a good starting point (used by FastAPI) |
This is a good suggestion. Just note that we should do a quick due diligence and compare it to sphinx (actually, the theme used by scikit-learn), and collect pros and cons. I know some people in the team would like us to follow unified conventions, but we can break them if we know there are a good reasons. |
We should use the same theme and system as scikit-learn (PyData theme for sphinx). |
The README will shortly show its limits, so we want to develop a proper documentation.
From a bird's eye view, we need:
The text was updated successfully, but these errors were encountered: