The OpenML documentation in written in MarkDown. The sources are generated by MkDocs, using the Material theme. Check these links to see what is possible in terms of styling.

The overal structure (navigation) of the docs is configurated in the mkdocs.yml file.

This documentation of other APIs is pulled in using the multirepo plugin to gather all docs into the same place, but they need to be edited in their own GitHub repo's. This allows the documentation to live closer to the code and follow conventions of the respective community.

Documentation can be edited by simply editing the markdown files in the docs folder and creating a pull request.

End users can edit the docs by simply clicking the edit button (the pencil icon) on the top of every documentation page. It will open up an editing page on GitHub (you do need to be logged in on GitHub). When you are done, add a small message explaining the change and click 'commit changes'. On the next page, just launch the pull request. We will then review it and approve the changes, or discuss them if necessary.

For other information on how to write and build documentation locally, see our contributing page.

The documentation is hosted on GitHub pages.

To deploy the documentation, you need to have MkDocs installed locally, and then run mkdocs gh-deploy in the top directory (with the mkdocs.yml file). This will build the HTML files and push them to the gh-pages branch of openml/docs. https://docs.openml.org is just a reverse proxy for https://openml.github.io/docs/.

MkDocs and all required extensions can be installed as follows:

pip install -r requirements.txt

To test the documentation locally, run

mkdocs serve

To deploy to GitHub Pages, run

mkdocs gh-deploy