Skip to content

Commit 23e9c1a

Browse files
committed
generate doc/requirements.txt
As suggested in #10030 (review)
1 parent 12e228c commit 23e9c1a

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

.github/workflows/users-guide.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ jobs:
6262
6363
- name: Create requirements.txt from requirements.in
6464
run: |
65-
cd doc && pip-compile requirements.in
65+
make users-guide-requirements
6666
6767
# Subsumed by make users-guide
6868
# - name: Install dependencies

.readthedocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ build:
1010
jobs:
1111
post_create_environment:
1212
- pip install pip-tools
13-
- cd doc && pip-compile requirements.in
13+
- make users-guide-requirements
1414

1515
python:
1616
install:

doc/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ http://cabal.readthedocs.io/
1111

1212
### How to build it
1313

14-
Building the documentation requires Python 3, PIP, and pip-tools. Run the following command either from the root of the cabal repository or from the `docs/` subdirectory:
14+
Building the documentation requires Python 3, PIP, and `pip-tools` (see the second note below for how to install it). Run the following command either from the root of the cabal repository or from the `docs/` subdirectory:
1515

1616
``` console
1717
> make users-guide
@@ -23,7 +23,7 @@ and instead set `LC_ALL=en_US.UTF-8`.
2323
Note: You can use a vendor package for `pip-tools`, or run
2424

2525
``` console
26-
pip install pip-tools
26+
> pip install pip-tools
2727
```
2828

2929
Make sure the installation directory (often `$HOME/.local/bin`) is on your `$PATH`.
@@ -36,9 +36,9 @@ The list of transitive dependencies (`requirements.txt`) is generated from the l
3636
> make users-guide-requirements
3737
```
3838

39-
either from the root of the cabal repository or from the `docs/` subdirectory. You will need to do this before building documentation the first time, but should only need to repeat it after a `git clean` or if the dependencies change.
39+
either from the root of the cabal repository or from the `docs/` subdirectory. You will need to do this before building documentation the first time, but should only need to repeat it after a `git clean` or if the dependencies in `requirements.in` change.
4040

41-
In some cases you may have to add a bound manually to `requirements.in`, e.g. `requests >= 2.31.0`.
41+
In some cases, you may have to add a bound manually to `requirements.in`, e.g. `requests >= 2.31.0`.
4242

4343
### Gitpod workflow
4444

0 commit comments

Comments
 (0)