Skip to content

Commit

Permalink
fix(docs): point poetry readthedocs virtual env
Browse files Browse the repository at this point in the history
RTD uses a mixture of poetry and pip to install packages in the build
environment. In the past it was recommended to disable poetry from
creating a fresh virtual environment. Instead, the expectation was that
poetry would be able to detect it's current virtual environment and
install the packages in the right place. This was recently updated to
allow poetry to better allow dependcy management by poetry [1]. Remove
this configuration and explicitly point Poetry to the virtual
environment.

[1] readthedocs/readthedocs.org#11152

Signed-off-by: J-Alves <[email protected]>
Signed-off-by: Harrison Mutai <[email protected]>
Change-Id: I64e75410a0f14ff5edd91ea526d85ad108cb1a13
  • Loading branch information
J-Alves committed Aug 2, 2024
1 parent bd43209 commit 77f39c2
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ build:
jobs:
post_create_environment:
- pip install poetry=="1.3.2"
- poetry config virtualenvs.create false
post_install:
- poetry install --with doc
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with doc

sphinx:
configuration: docs/conf.py

0 comments on commit 77f39c2

Please sign in to comment.