diff --git a/.readthedocs.yml b/.readthedocs.yml index ac24f58..8835e4f 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,5 +1,6 @@ # Read the Docs configuration file for Sphinx projects # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +# If build fails check https://docs.readthedocs.io/en/latest/build-customization.html#install-dependencies-with-poetry for updates # Required version: 2 @@ -11,10 +12,15 @@ build: python: "3.10" jobs: post_create_environment: + # Install poetry + # https://python-poetry.org/docs/#installing-manually - pip install poetry - - poetry config virtualenvs.create false post_install: - - poetry install --with docs + # Install dependencies with 'docs' dependency group + # https://python-poetry.org/docs/managing-dependencies/#dependency-groups + # VIRTUAL_ENV needs to be set manually for now. + # See https://github.com/readthedocs/readthedocs.org/pull/11152/ + - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs # Build documentation in the "docs/" directory with Sphinx sphinx: