From 2aca7c4b6a7162b6def635aee1c87447102b5b0b Mon Sep 17 00:00:00 2001
From: brandon s allbery kf8nh <allbery.b@gmail.com>
Date: Fri, 17 May 2024 22:34:26 -0400
Subject: [PATCH] generate doc/requirements.txt

As suggested in https://github.com/haskell/cabal/pull/10030#pullrequestreview-2064505535
---
 .github/workflows/users-guide.yml | 10 +++-
 .gitignore                        |  1 +
 .readthedocs.yml                  |  4 ++
 doc/requirements.txt              | 79 -------------------------------
 4 files changed, 13 insertions(+), 81 deletions(-)
 delete mode 100644 doc/requirements.txt

diff --git a/.github/workflows/users-guide.yml b/.github/workflows/users-guide.yml
index 8047ede1031..c0a08fdbc07 100644
--- a/.github/workflows/users-guide.yml
+++ b/.github/workflows/users-guide.yml
@@ -15,7 +15,6 @@ on:
     - 'doc/Makefile'
     - 'doc/pyproject.toml'
     - 'doc/requirements.in'
-    - 'doc/requirements.txt'
     - 'doc/*.inc'
     - 'doc/*.py'
     - 'doc/*.rst'
@@ -26,7 +25,6 @@ on:
     - 'doc/Makefile'
     - 'doc/pyproject.toml'
     - 'doc/requirements.in'
-    - 'doc/requirements.txt'
     - 'doc/*.inc'
     - 'doc/*.py'
     - 'doc/*.rst'
@@ -58,6 +56,14 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
+    - name: Install pip-compile
+      run: |
+        pip install pip-tools
+
+    - name: Create requirements.txt from requirements.in
+      run: |
+        cd doc && pip-compile requirements.in
+
     # Subsumed by make users-guide
     # - name: Install dependencies
     #   run: |
diff --git a/.gitignore b/.gitignore
index 3e0b65c8085..97632785e28 100644
--- a/.gitignore
+++ b/.gitignore
@@ -87,6 +87,7 @@ cabal-testsuite/**/haddocks
 venv
 .venv
 /doc/.skjold_cache/
+/doc/requirements.txt
 
 # macOS folder metadata
 .DS_Store
diff --git a/.readthedocs.yml b/.readthedocs.yml
index 016f7e47a48..e4d16411444 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -7,6 +7,10 @@ build:
   os: "ubuntu-22.04"
   tools:
     python: "3.8"
+  jobs:
+    post_create_environment:
+      - pip install pip-tools
+      - cd doc && pip-compile requirements.in
 
 python:
   install:
diff --git a/doc/requirements.txt b/doc/requirements.txt
deleted file mode 100644
index ca9ca747a7b..00000000000
--- a/doc/requirements.txt
+++ /dev/null
@@ -1,79 +0,0 @@
-#
-# This file is autogenerated by pip-compile with Python 3.11
-# by the following command:
-#
-#    pip-compile requirements.in
-#
-alabaster==0.7.13
-    # via sphinx
-babel==2.12.1
-    # via sphinx
-certifi==2023.7.22
-    # via
-    #   -r requirements.in
-    #   requests
-charset-normalizer==3.1.0
-    # via requests
-docutils==0.18.1
-    # via
-    #   sphinx
-    #   sphinx-jsonschema
-    #   sphinx-rtd-theme
-idna==3.7
-    # via
-    #   -r requirements.in
-    #   requests
-imagesize==1.4.1
-    # via sphinx
-jinja2==3.1.3
-    # via
-    #   -r requirements.in
-    #   sphinx
-jsonpointer==2.3
-    # via sphinx-jsonschema
-markupsafe==2.1.2
-    # via jinja2
-packaging==23.1
-    # via sphinx
-pygments==2.15.1
-    # via
-    #   -r requirements.in
-    #   sphinx
-pyyaml==6.0
-    # via sphinx-jsonschema
-requests==2.31.0
-    # via
-    #   sphinx
-    #   sphinx-jsonschema
-snowballstemmer==2.2.0
-    # via sphinx
-sphinx==5.3.0
-    # via
-    #   -r requirements.in
-    #   sphinx-rtd-theme
-    #   sphinxcontrib-jquery
-    #   sphinxnotes-strike
-sphinx-jsonschema==1.19.1
-    # via -r requirements.in
-sphinx-rtd-theme==1.2.1
-    # via -r requirements.in
-sphinxcontrib-applehelp==1.0.4
-    # via sphinx
-sphinxcontrib-devhelp==1.0.2
-    # via sphinx
-sphinxcontrib-htmlhelp==2.0.1
-    # via sphinx
-sphinxcontrib-jquery==4.1
-    # via sphinx-rtd-theme
-sphinxcontrib-jsmath==1.0.1
-    # via sphinx
-sphinxcontrib-qthelp==1.0.3
-    # via sphinx
-sphinxcontrib-serializinghtml==1.1.5
-    # via sphinx
-sphinxnotes-strike==1.2
-    # via -r requirements.in
-urllib3==2.0.7
-    # via
-    #   -r requirements.in
-    #   requests