diff --git a/.github/workflows/users-guide.yml b/.github/workflows/users-guide.yml index c0a08fdbc07..8442b39c2f4 100644 --- a/.github/workflows/users-guide.yml +++ b/.github/workflows/users-guide.yml @@ -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 diff --git a/.readthedocs.yml b/.readthedocs.yml index e4d16411444..31bb9507b4f 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -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: diff --git a/doc/README.md b/doc/README.md index f8873bbdb91..871ae85d068 100644 --- a/doc/README.md +++ b/doc/README.md @@ -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 @@ -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`. @@ -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