Skip to content

Commit 227ddc6

Browse files
x1101oraNodsamccann
authored
Add initial README.md for tests/ requirement files (#2577)
* Add initial README.md for tests/ requirement files * Update tests/README.md Update Heading, per @oraNod's suggestion Co-authored-by: Don Naro <[email protected]> * Move "txt" files to colum for "in" files, update description on "constraints" * Update tests/README.md Co-authored-by: Sandra McCann <[email protected]> * Update tests/README.md Co-authored-by: Sandra McCann <[email protected]> * Change Requirements to Dependencies per @webknjaz * Applying Changes per @oraNod * Update tests/README.md Co-authored-by: Don Naro <[email protected]> * Apply suggestions from code review Co-authored-by: Don Naro <[email protected]> --------- Co-authored-by: Don Naro <[email protected]> Co-authored-by: Sandra McCann <[email protected]>
1 parent 21a526c commit 227ddc6

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

tests/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Descriptions of requirements files
2+
3+
The following table explains the purpose of the `.in` and `.txt` files in the `tests/` directory of this repository:
4+
5+
| File | Purpose | Pip Constraints file (when relevant) |
6+
| ---- | ------- | ------------------------------------ |
7+
|constraints.in | Pins/version bounds for sphinx and antsibull-docs for known issues | -- |
8+
|formatters.in | List of Formatters required | formatters.txt |
9+
|pr_labeler.in | Dependencies for the labeler workflow | pr_labeler.txt |
10+
|requirements.in | Dependencies for the Sphinx docs builds | requirements.txt |
11+
|pip-compile.in | Dependencies for the `pip-compile` nox session | pip-compile.txt |
12+
|spelling.in | Dependencies for the `spelling` nox session | spelling.txt |
13+
|static.in | Dependencies for the `static` nox session | static.txt |
14+
|tag.in | Dependencies for the `tag` nox session | tag.txt |
15+
|typing.in | Dependencies for the `typing` nox session | typing.txt |

0 commit comments

Comments
 (0)