Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ name: Deploy Docs
on:
push:
branches:
- "add/docs"
- main

permissions:
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ The following `yaml` files have schemas:
`JSON` > `Edit in settings.json`. There, add mappings per file or
file pattern. For example:

```bash
```json
"json.schemas": [
{
"fileMatch": [
Expand Down
19 changes: 17 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,25 @@ The OpenML server will be developed and maintained for the latest minor release
Python (Python 3.12 as of writing).
You can install the dependencies locally or work with docker containers.

!!! tip "Use `pyenv` to manage Python installations"
??? tip "Use `pyenv` to manage Python installations"

We recommend using [`pyenv`](https://github.com/pyenv/pyenv) if you are working with
multiple local Python versions.
multiple local Python versions. After following the installation instructions for
`pyenv` check that you can execute it:

```text
> pyenv local
3.12
```

If `pyenv` can't be found, please make sure to update the terminal environment
(either by `reset`ing it, or by closing and opening the terminal). If you get the message
`pyenv: no local version configured for this directory` first clone the repository
as described below and try again from the root of the cloned repository.

You can then install the Python version this project uses with:
`cat .python-version | pyenv install`


## Local Installation

Expand Down