Skip to content

Commit

Permalink
fix: correct suggestion for RtD (#272)
Browse files Browse the repository at this point in the history
Signed-off-by: Henry Schreiner <[email protected]>
  • Loading branch information
henryiii authored Sep 5, 2023
1 parent d50039c commit ac681ae
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/sp_repo_review/checks/readthedocs.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,17 @@ class RTD102(ReadTheDocs):
@staticmethod
def check(readthedocs: dict[str, Any]) -> bool:
"""
You must set `build: image: ubuntu-22.04` or similar in the
You must set `build: os: ubuntu-22.04` or similar in the
`.readthedocs.yaml` file. Otherwise, you will get old, unsupported
versions of software for backward compatibility.
[Suggestion](https://docs.readthedocs.io/en/stable/config-file/v2.html):
```yaml
build:
os: ubuntu-22.04
tools:
python: "3.11"
```
"""

match readthedocs:
Expand Down

0 comments on commit ac681ae

Please sign in to comment.