Skip to content
OpenML documentation
Branch: master
Clone or download
Latest commit b5d4ee7 Jul 5, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
site fix links Jul 5, 2019
README.md
mkdocs.yml fix links Jul 5, 2019
queries.yml

README.md

OpenML documentation

Documentation structure

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.

Some of the API's use other documentation generators, such as Sfinx in openml-python. This documentation is pulled in via iframes to gather all docs into the same place, but they need to be edited in their own GitHub repo's.

Editing documentation

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.

Deployment

The documentation is hosted on GitHub pages.

To deploy the documentation, you need to have MkDocs and MkDocs-Material installed, 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 MkDocs-Material can be installed as follows:

pip install mkdocs
pip install mkdocs-material
pip install -U fontawesome_markdown
You can’t perform that action at this time.