Skip to content

Commit

Permalink
generate doc/requirements.txt
Browse files Browse the repository at this point in the history
As suggested in #10030 (review)
  • Loading branch information
geekosaur committed May 19, 2024
1 parent 17bc8c1 commit d0205af
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/users-guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ jobs:
- name: Create requirements.txt from requirements.in
run: |
cd doc && pip-compile requirements.in
make users-guide-requirements
# Subsumed by make users-guide
# - name: Install dependencies
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ build:
jobs:
post_create_environment:
- pip install pip-tools
- cd doc && pip-compile requirements.in
- make users-guide-requirements

python:
install:
Expand Down
8 changes: 4 additions & 4 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ http://cabal.readthedocs.io/

### How to build it

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:
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:

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

``` console
pip install pip-tools
> pip install pip-tools
```

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

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.
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.

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

### Gitpod workflow

Expand Down

0 comments on commit d0205af

Please sign in to comment.