Skip to content

Commit

Permalink
Fix ReadTheDocs build to support Pipenv
Browse files Browse the repository at this point in the history
I accidentally broke the RTD build with
253b4b6 when moving from
requirements.txt to Pipenv

This was not helped by not having automated tests for RTD builds - I
have subsequently enabled RTD Pull Request Previews
(https://docs.readthedocs.io/en/stable/pull-requests.html) to find out
in advance if anything is broken(!)

In terms of the core issue, RTD have decided to not support Pipenv
(readthedocs/readthedocs.org#8851 etc.) so
instead we shim things:

Rather than adopt a full-on "make RTD use Pipenv for dependencies", this
just has Pipenv generate a requirements.txt for RTD to use as it did
previously
  • Loading branch information
doismellburning committed Oct 1, 2023
1 parent 0521c12 commit caa7a56
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ build:
os: "ubuntu-22.04"
tools:
python: "3.11"
jobs:
pre_install:
- "pip install pipenv --user"
- "pipenv requirements > requirements.txt"

sphinx:
builder: "dirhtml"
Expand Down

0 comments on commit caa7a56

Please sign in to comment.