Commit graph

12 commits

Author SHA1 Message Date
Niklas Rosenstein
5ecfc3d900
Update docs on how to use UV_PROJECT_ENVIRONMENT to use the system python environment (#10817)
## Summary

The docs did mention that you could set the `UV_PROJECT_ENVIRONMENT`
variable to point Uv to use the system Python environment (e.g. for use
in CI or Docker), but it did not document _how_.

Reference:
https://github.com/astral-sh/uv/pull/6834#issuecomment-2319253359

---------

Co-authored-by: Zanie Blue <contact@zanie.dev>
2025-01-21 18:40:01 +00:00
Se7en
d5b98fb76c
fix: links in configuring projects doc (#10710)
<!--
Thank you for contributing to uv! To help us out with reviewing, please
consider the following:

- Does this pull request include a summary of the change? (See below.)
- Does this pull request include a descriptive title?
- Does this pull request include references to any relevant issues?
-->

## Summary

<!-- What's the purpose of the change? What does it do, and why? -->

Fix invalid links in [configuring
projects](https://docs.astral.sh/uv/concepts/projects/config/#entry-points)
doc.

## Test Plan

<!-- How was it tested? -->
2025-01-17 12:39:56 -06:00
FishAlchemist
201726cda5
docs: Clarify build system specific features usage. (#10261)
## Summary
Since there are occasional inquiries about how to configure UV for
build-system specific features, I want to raise awareness that users
should refer to the documentation of the build system they are using for
relevant settings.
## Test Plan
Run docs service in local.

9821d58d35

![image](https://github.com/user-attachments/assets/3c07ac15-a562-40e2-9289-204c0975261f)

---------

Signed-off-by: FishAlchemist <48265002+FishAlchemist@users.noreply.github.com>
Co-authored-by: Zanie Blue <contact@zanie.dev>
2025-01-09 11:41:04 -06:00
Zanie Blue
c3904a65c4
Mention uv pip behavior in build system note (#9586)
xref https://github.com/astral-sh/uv/issues/9518
2024-12-02 16:56:46 -06:00
Zanie Blue
be651ed32d
Fix typo in entry point docs (#9491) 2024-11-28 02:48:52 +00:00
Zanie Blue
7df3ae2585
Add Python implementation example to limited resolution environments docs (#9475)
Closes https://github.com/astral-sh/uv/issues/9473
2024-11-27 09:53:39 -06:00
Zanie Blue
6afb34091c
Expand entry points documentation (#9329) 2024-11-27 09:53:07 -06:00
Zanie Blue
82f96903ba
Fix header level of "Conflicting dependencies" page (#9330) 2024-11-21 11:44:22 -06:00
Jon Åslund
98c96b718f
Fix example pyproject.toml in project concept documentation (#9298)
The snippet out of context looks like a valid minimal pyproject.toml
which it is not without name and version. The line worked in layout.md
before when it was just under the minimal config.

---------

Co-authored-by: Zanie Blue <contact@zanie.dev>
2024-11-21 00:39:39 +00:00
Zanie Blue
110c38e549
Improve the project creation documentation (#9236) 2024-11-20 08:50:14 -06:00
Zanie Blue
20eccc157c
Improve content on project configuration (#9235) 2024-11-20 08:49:51 -06:00
Zanie Blue
ca9aaf1c48
Reorganize the project concept documentation (#9121)
- Adds a collapsible section for the project concept
- Splits the project concept document into several child documents.
- Moves the workspace and dependencies documents to under the project
section
- Adds a mkdocs plugin for redirects, so links to the moved documents
still work

I attempted to make the minimum required changes to the contents of the
documents here. There is a lot of room for improvement on the content of
each new child document. For review purposes, I want to do that work
separately. I'd prefer if the review focused on this structure and idea
rather than the content of the files.

I expect to do this to other documentation pages that would otherwise be
very nested.

The project concept landing page and nav (collapsed by default) looks
like this now:

<img width="1507" alt="Screenshot 2024-11-14 at 11 28 45 AM"
src="https://github.com/user-attachments/assets/88288b09-8463-49d4-84ba-ee27144b62a5">
2024-11-19 13:52:12 -06:00