Skip to content

Add initial README.md for tests/ requirement files #2577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: devel
Choose a base branch
from
15 changes: 15 additions & 0 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Descriptions of requirements files

The following table explains the purpose of the `.in` and `.txt` files in the `tests/` directory of this repository:

| File | Purpose | Pip Constraints file (when relevant) |
| ---- | ------- | ------------------------------------ |
|constraints.in | Pins/version bounds for sphinx and antsibull-docs for known issues | -- |
|formatters.in | List of Formatters required | formatters.txt |
|pr_labeler.in | Dependencies for the labeler workflow | pr_labeler.txt |
|requirements.in | Dependencies for the Sphinx docs builds | requirements.txt |
|pip-compile.in | Dependencies for the `pip-compile` nox session | pip-compile.txt |
|spelling.in | Dependencies for the `spelling` nox session | spelling.txt |
|static.in | Dependencies for the `static` nox session | static.txt |
|tag.in | Dependencies for the `tag` nox session | tag.txt |
|typing.in | Dependencies for the `typing` nox session | typing.txt |