Skip to content

Commit be8f874

Browse files
committed
README.md - people should use exactly 3.13, update instructions about pyenv
1 parent 51b829f commit be8f874

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,22 @@ Subsequent instructions assume that your current working directory is `os4d`, un
2424

2525
#### Create and activate a Python virtual environment
2626

27-
The following instructions assume you have [Python 3.10](https://www.python.org/downloads/) or newer installed on your machine.
27+
The following instructions assume you have [Python 3.13](https://www.python.org/downloads/) installed on your machine, as we need to use the same version of python the docs are built with.
2828

29-
You can use either [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv), `python3-venv` or a Python environment manager of your choice:
29+
If you already have 3.13 you can use `python3-venv` or a Python environment manager of your choice.
30+
31+
If not we recommend pyenv.
3032

3133
##### pyenv
3234

3335
1. Install [pyenv](https://github.com/pyenv/pyenv) and the [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv) plugin. The [pyenv installer](https://github.com/pyenv/pyenv-installer) is recommended.
36+
1. Set up Python 3.13 using pyenv:
37+
38+
```bash
39+
pyenv install 3.13
40+
pyenv local 3.13
41+
```
42+
3443
1. Create a virtual environment:
3544

3645
```bash
@@ -188,4 +197,4 @@ Read the Docs automatically creates and builds [pull request previews](https://d
188197
189198
#### Credentials
190199
191-
You can find credentials for Read the Docs in the Open Data Services password database.
200+
You can find credentials for Read the Docs in the Open Data Services password database.

0 commit comments

Comments
 (0)