Document that pyproject.toml dependencies are supported · jazzband/pip-tools#1528

(3 comments) (7 reactions) (0 assignees)Python (7,230 stars) (605 forks)batch import

PR wanteddocsgood first issue

Description

Issues like: #1510, general confusion

At the moment, the docs include phrases like:

The pip-compile command lets you compile a requirements.txt file from your dependencies, specified in either setup.py or requirements.in.

pip-compile generates a requirements.txt file using the latest versions that fulfil the dependencies of setup.py or requirements.in.

To me, and I assume the person who opened #1510, this reads like only setup.py or requirements.in are supported.

Tech stack: python
Domain: documentation
Issue type: documentation
Difficulty: 2
Estimated time: under 1 hour
Activity status: stale
Clarity: clear
Prerequisites: Python packaging basicspip tools familiaritypyproject.toml understanding
Newbie friendliness: 80
Research direction: The issue requests updating documentation references to include pyproject.toml alongside setup.py and requirements.in. Start by searching the repository's documentation files (e.g., README.rst, docs/index.rst) for phrases like 'setup.py or requirements.in' and add pyproject.toml as a supported format. Verify in the source code (e.g., pipcompile.py) that pyproject.toml is indeed supported to ensure accuracy. Finally, ensure all occurrences across the docs are consistently updated.