centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-26 13:18:58 +07:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* Add initial README.md for tests/ requirement files

* Update tests/README.md

Update Heading, per @oraNod's suggestion

Co-authored-by: Don Naro <dnaro@redhat.com>

* Move "txt" files to colum for "in" files, update description on "constraints"

* Update tests/README.md

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update tests/README.md

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Change Requirements to Dependencies per @webknjaz

* Applying Changes per @oraNod

* Update tests/README.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Apply suggestions from code review

Co-authored-by: Don Naro <dnaro@redhat.com>

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
This commit is contained in:
Lyle McKarns
2025-07-11 04:11:26 -04:00
committed by GitHub
parent 21a526c87d
commit 227ddc6aaf
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
tests/README.md Normal file
View File

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