From b83d13305fb1bc9fe6fa028ea3deaabf8b021736 Mon Sep 17 00:00:00 2001
From: PGijsbers
Date: Wed, 8 Nov 2023 14:17:38 +0100
Subject: [PATCH 1/3] Add extra information for troubleshooting pyenv
---
docs/installation.md | 19 +++++++++++++++++--
1 file changed, 17 insertions(+), 2 deletions(-)
diff --git a/docs/installation.md b/docs/installation.md
index f1371892..b2396017 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -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
From 650a9d4d5741ad8c123a98ef4ab324c57c8b882e Mon Sep 17 00:00:00 2001
From: PGijsbers
Date: Wed, 8 Nov 2023 14:18:26 +0100
Subject: [PATCH 2/3] Add JSON syntax highlighting for JSON code block
---
docs/contributing/contributing.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/contributing/contributing.md b/docs/contributing/contributing.md
index 6de6c53c..2997dbc4 100644
--- a/docs/contributing/contributing.md
+++ b/docs/contributing/contributing.md
@@ -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": [
From 8120038109e056bbd0239b8c9bc05edef5f58d88 Mon Sep 17 00:00:00 2001
From: PGijsbers
Date: Wed, 8 Nov 2023 14:22:14 +0100
Subject: [PATCH 3/3] Remove backdoor for updating docs from `add/docs` branch
---
.github/workflows/docs.yml | 1 -
1 file changed, 1 deletion(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 5fcec20e..7421deea 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -3,7 +3,6 @@ name: Deploy Docs
on:
push:
branches:
- - "add/docs"
- main
permissions: