mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-07-07 13:25:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
uv/docs
History
Charlie Marsh 41cd4bee58
Add a generate-all step and auto-generate settings.md (#5080) 
## Summary

Ensures that `generate-all` generates both the JSON Schema and the
`settings.md` API reference.
2024-07-15 19:58:53 +00:00
..
configuration Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
guides Docs: Add guide for authenticating to Azure Artifacts (#4857) 2024-07-15 11:06:50 -05:00
pip Restructure documentation sections to focus on new user experience (#4586) 2024-07-02 11:44:45 -05:00
preview Remove extra "project" docs files (#4977) 2024-07-10 17:38:13 -05:00
theme Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
.gitignore Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
book.toml Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
cache.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
first-steps.md Change "toolchain" to "python" (#4735) 2024-07-03 07:44:29 -05:00
installation.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
introduction.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
platforms.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
python-versions.md Update "Python versions" documentation (#4943) 2024-07-10 01:07:27 +00:00
python.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
README.md Add page for contributing to the docs (#4562) 2024-06-27 07:27:58 -05:00
resolution.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
settings.md Add a generate-all step and auto-generate settings.md (#5080) 2024-07-15 19:58:53 +00:00
style.css Restructure documentation sections to focus on new user experience (#4586) 2024-07-02 11:44:45 -05:00
SUMMARY.md Update "Python versions" documentation (#4943) 2024-07-10 01:07:27 +00:00
versioning.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00

README.md

Documentation

This is the home of the new documentation for uv.

The documentation is a work in progress and not ready for external references.

Contributing

Install mdbook:

cargo install mdbook

To run the documentation locally:

mdbook watch docs --open

The documentation is published to GitHub Pages on merge to main.