Skip to content

Commit afa2626

Browse files
authored
Fix docs build & modernize Poetry (#16)
1 parent e0c91b9 commit afa2626

File tree

4 files changed

+193
-205
lines changed

4 files changed

+193
-205
lines changed

.readthedocs.yml

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,19 @@ version: 2
33
sphinx:
44
configuration: docs/conf.py
55

6-
# https://github.com/readthedocs/readthedocs.org/issues/4912#issuecomment-664002569
7-
python:
8-
version: 3.8
9-
install:
10-
- method: pip
11-
path: .
12-
extra_requirements:
13-
- docs
6+
# https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-poetry
7+
build:
8+
os: "ubuntu-22.04"
9+
tools:
10+
python: "3.8"
11+
jobs:
12+
post_create_environment:
13+
# Install poetry
14+
# https://python-poetry.org/docs/#installing-manually
15+
- pip install poetry
16+
# Tell poetry to not use a virtual environment
17+
- poetry config virtualenvs.create false
18+
post_install:
19+
# Install dependencies with 'docs' dependency group
20+
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
21+
- poetry install --only main,docs

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ GeoGIF is managed by [Poetry](https://python-poetry.org/), so be sure that's ins
3636

3737
```bash
3838
cd geogif
39-
poetry install -E tests -E docs
39+
poetry install
4040
```
4141

4242
### Running Tests

0 commit comments

Comments
 (0)