From b2ae2f72db0a1c05905ed2ee5b1b81bfb6ccab73 Mon Sep 17 00:00:00 2001 From: Tiffany Timbers Date: Wed, 10 Jan 2024 11:46:04 -0800 Subject: [PATCH] updated the cookiecutter .readthedocs.yml to install poetry and the package so that docs/example.ipynb can be successfully executed --- .../.readthedocs.yml | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/{{ cookiecutter.__package_slug }}/.readthedocs.yml b/{{ cookiecutter.__package_slug }}/.readthedocs.yml index 99af8f3..ae72745 100644 --- a/{{ cookiecutter.__package_slug }}/.readthedocs.yml +++ b/{{ cookiecutter.__package_slug }}/.readthedocs.yml @@ -10,14 +10,18 @@ build: os: ubuntu-22.04 tools: python: "3.9" - + jobs: + post_create_environment: + # Install poetry + # https://python-poetry.org/docs/#installing-manually + - pip install poetry + # Tell poetry to not use a virtual environment + - poetry config virtualenvs.create false + post_install: + # Install dependencies with 'docs' dependency group + # https://python-poetry.org/docs/managing-dependencies/#dependency-groups + - poetry install + # Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/conf.py - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: docs/requirements.txt