From 87327cec8e4281079d769733262dd57443b53d36 Mon Sep 17 00:00:00 2001
From: Anders <6058745+ddabble@users.noreply.github.com>
Date: Wed, 15 May 2024 16:54:30 +0200
Subject: [PATCH] [docs] Install project in yaml instead of reqs (#1332)

Context: bd26f1906f2e2c50fd24be616a2252d0c8682a1c

This (refactor, technically) was motivated by fixing a Dependabot error
that prevented it from creating new dependency PRs.
Error message:

> **Dependabot couldn't fetch all your path-based dependencies**
> The affected dependencies were `"-e ." at /requirements/docs.txt`.
>
> To use path-based dependencies with Dependabot the paths must be relative, resolve to a directory in this project's source code, and contain a valid Python project.

(From https://github.com/jazzband/django-simple-history/network/updates/827989501.)

Evidence that RTD still builds successfully:
https://readthedocs.org/projects/ddabble-django-simple-history/builds/24379182/
---
 .readthedocs.yaml     | 3 +++
 requirements/docs.txt | 2 --
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 7e1713f6..87b8a417 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -21,3 +21,6 @@ sphinx:
 python:
   install:
     - requirements: requirements/docs.txt
+    # Install this project locally, so that its package metadata can be queried
+    - method: pip
+      path: .
diff --git a/requirements/docs.txt b/requirements/docs.txt
index 06417b80..c71ccc8d 100644
--- a/requirements/docs.txt
+++ b/requirements/docs.txt
@@ -1,4 +1,2 @@
-# Install this project in editable mode, so that its package metadata can be queried
--e .
 Sphinx==7.2.6
 sphinx-rtd-theme==1.3.0