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

User Guide and API documentation #412

Closed
tuscland opened this issue Sep 30, 2024 · 4 comments · Fixed by #582
Closed

User Guide and API documentation #412

tuscland opened this issue Sep 30, 2024 · 4 comments · Fixed by #582
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@tuscland
Copy link
Member

The README will shortly show its limits, so we want to develop a proper documentation.

From a bird's eye view, we need:

  • Content: at minimal, an expanded version of the README, and the API reference.
  • Hosting: a place to host the documentation, GH pages?
  • Version control: make it so future documentation is available as pre-release, and also host older versions (just like scikit-learn docs).
@tuscland tuscland added the question Further information is requested label Sep 30, 2024
@augustebaum
Copy link
Contributor

I think Material for MkDocs is a good starting point (used by FastAPI)

@tuscland
Copy link
Member Author

tuscland commented Oct 3, 2024

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.

@tuscland
Copy link
Member Author

tuscland commented Oct 8, 2024

We should use the same theme and system as scikit-learn (PyData theme for sphinx).

@thomass-dev
Copy link
Collaborator

Closed by #553 #582 #584.

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
4 participants