Pin pip-tools' dependencies for "build-docs" #2219
Conversation
In order to get consistent doc builds, we need the dependencies of `pip-tools` (in particular, right now we need `pip`) pinned to versions where the build works. In order to provide a `requirements.txt` file with these pins, we add `.` to `docs/requirements.in`. This requires a couple of tweaks: - Use `-e .` so that `pip-compile` preserves it as a relative path - Remove the `changedir` tox directive, so that doc building and pinning happens from the tox ini dir (repo root) Additionally, `pip` itself is downgraded from 25.2 (where we have the doc build issue today) to 25.1 . Other updates to `docs/requirements.txt` occur as side-effects of this change. New packages are added and paths are updated.
|
I'm so glad I asked to add the changelog draft job into the CI 😂 |
|
Oh, I forgot to post this comment! It's been sitting in a tab for a few hours! 😅 CI failure on the changelog-draft job: So I don't think I can do this the way that I wanted. That error makes it look like I could hack it by using |
|
This is something I've been annoyed about for quite some time. We should really work on a better story for |
Rather than trying to pin `-e .` in the docs/requirements.in, use `./pyproject.toml` on the command-line. As a part of this change, break the command across multiple lines for readability.
|
I've made an additional tweak here to use |
|
Oh, that's a clever workaround. Nice! |
This is split off from #2218. This part will have no changelog, #2218 will have a contrib changelog entry.
In order to get consistent doc builds, we need the dependencies of
pip-tools(in particular, right now we needpip) pinned toversions where the build works.
In order to provide a
requirements.txtfile with these pins, we add.todocs/requirements.in. This requires a couple of tweaks:-e .so thatpip-compilepreserves it as a relative pathchangedirtox directive, so that doc building andpinning happens from the tox ini dir (repo root)
Additionally,
pipitself is downgraded from 25.2 (where we have thedoc build issue today) to 25.1 .
Other updates to
docs/requirements.txtoccur as side-effects of thischange. New packages are added and paths are updated.
Contributor checklist
changelog.d/(seechangelog.d/README.mdfor instructions) or the PR text says "no changelog needed".Maintainer checklist
skip-changeloglabel.