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

Convert documentation to mkdocs #1339

Open
PGijsbers opened this issue Jul 1, 2024 · 1 comment
Open

Convert documentation to mkdocs #1339

PGijsbers opened this issue Jul 1, 2024 · 1 comment
Milestone

Comments

@PGijsbers
Copy link
Collaborator

In order to be able to generate openml-wide documentation that incorporates the documentation of the different programmatic interfaces, we have decided that each subproject should provide their documentation in mkdocs format.

@PGijsbers PGijsbers added this to the 0.16.0 milestone Oct 16, 2024
@PGijsbers
Copy link
Collaborator Author

See the https://github.com/openml/openml-python/tree/docs/mkdoc branch already builds the docs, but there are some files that needed to be converted to another format. Primarily the examples to Jupytext. Also some other formatting couldn't be transformed automatically.
There should be some doc pages built already when you do python -m mkdocs serve.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant