Skip to content

Commit

Permalink
Replace non-existant python.install.package with `python.install.pa…
Browse files Browse the repository at this point in the history
…th` (#11301)

This confused me initially because I was looking in https://docs.readthedocs.io/en/stable/config-file/v2.html#packages for `python.install.package`, which simply doesn't exist.

Instead, this should probably be `python.install.path` which _is_ a required key (#11300), and defaults to `pip`.
  • Loading branch information
jeffwidman committed Apr 24, 2024
1 parent cb50bbf commit 36bc94a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/user/config-file/index.rst
Expand Up @@ -128,7 +128,7 @@ you should define the Python version in ``build.tools.python``.
The ``python`` key contains a list of sub-keys,
specifying the requirements to install.

- Use ``python.install.package`` to install the project itself as a Python package using pip
- Use ``python.install.path`` to install the project itself as a Python package using pip
- Use ``python.install.requirements`` to install packages from a requirements file
- Use ``build.jobs`` to install packages using Poetry or PDM

Expand Down

0 comments on commit 36bc94a

Please sign in to comment.