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.

Sign up for GitHub

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

Jump to bottom

Auto generate HTML docu #62

Open
JochenSiegWork opened this issue Aug 15, 2024 · 1 comment
Open

Auto generate HTML docu #62

JochenSiegWork opened this issue Aug 15, 2024 · 1 comment
Assignees
@JochenSiegWork
Labels
type: enhancement New feature or request
Milestone
v1.0.0

Comments

@JochenSiegWork
Copy link
Collaborator

It would be helpful for new users if we provide the documentation as a webpage in a sklearn-like fashion.

TODO: check how sklearn is generating its documentation. There is also sphinx and similar tools.
@JochenSiegWork JochenSiegWork self-assigned this Aug 15, 2024
@JochenSiegWork JochenSiegWork added the type: enhancement New feature or request label Aug 15, 2024
@c-w-feldmann
Copy link
Collaborator

We could also then later link to the doku: https://github.com/scikit-learn/scikit-learn/blob/94d4a33168329ffb38ed65905a4b90bf34598309/sklearn/utils/_estimator_html_repr.py#L454

@c-w-feldmann c-w-feldmann added this to the v1.0.0 milestone Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JochenSiegWork JochenSiegWork

Labels
type: enhancement New feature or request
Projects
None yet
Milestone
v1.0.0
Development

No branches or pull requests
2 participants
@c-w-feldmann @JochenSiegWork