From f3c73927ff465aadf82e86d0bfa8c5159616c612 Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Thu, 7 Dec 2023 13:11:05 -0500 Subject: [PATCH] fix: Pip install this project in the python environment. Since this example of the .readthedocs.yaml is in the python-template cookiecutter, every repo that uses it will have a setup.py and will be pip-installabale. So we should have it install it in the docs build environment by default to make auto documenting the code easier by default. --- .../.readthedocs.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/python-template/{{cookiecutter.placeholder_repo_name}}/.readthedocs.yaml b/python-template/{{cookiecutter.placeholder_repo_name}}/.readthedocs.yaml index b0d4d022..ce8bde28 100644 --- a/python-template/{{cookiecutter.placeholder_repo_name}}/.readthedocs.yaml +++ b/python-template/{{cookiecutter.placeholder_repo_name}}/.readthedocs.yaml @@ -19,3 +19,9 @@ build: python: install: - requirements: requirements/doc.txt + + # This will pip install this repo into the python environment + # if you are using this in a repo that is not pip installable + # then you should remove the following two lines. + - method: pip + path: .