https://github.com/openml/docs

OpenML documentation
https://github.com/openml/docs

hacktoberfest

Last synced: 8 months ago
JSON representation

OpenML documentation

• Host: GitHub
• URL: https://github.com/openml/docs
• Owner: openml
• Created: 2019-06-29T11:19:04.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2025-04-27T00:47:54.000Z (about 1 year ago)
• Last Synced: 2025-06-07T11:07:56.797Z (about 1 year ago)
• Topics: hacktoberfest
• Language: Python
• Homepage: https://docs.openml.org
• Size: 62.9 MB
• Stars: 21
• Watchers: 7
• Forks: 20
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing/OpenML-Docs.md

Awesome Lists containing this project

README

          
# OpenML documentation

## Documentation structure

The OpenML documentation in written in MarkDown. The sources are generated by [MkDocs](http://www.mkdocs.org/), using the [Material theme](https://squidfunk.github.io/mkdocs-material/). 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 [Sphinx](https://restcoder.readthedocs.io/en/latest/sphinx-docgen.html) 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](https://github.com/) (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

```