64c6caa57b
Fixup settings reference ( #5694 )
...
Fixes #5689
2024-08-01 16:41:26 +00:00
0f30c69624
Move settings reference to reference section ( #5689 )
...
Joining #5685 in a dedicated reference section
2024-08-01 16:20:30 +00:00
f107406727
Generate CLI reference for documentation ( #5685 )
...
Loosely based on [Cargo's
format](https://github.com/rust-lang/cargo/blob/master/src/doc/src/commands/cargo-build.md )
<img width="896" alt="Screenshot 2024-08-01 at 9 44 03 AM"
src="https://github.com/user-attachments/assets/7c016bb3-2b54-46af-8ea8-ce82e07a0e30 ">
Future work includes:
- Grouping options
- Enforcing some sort of specific command ordering
- Showing possible values for enums
- Adding "long_about" to commands for more context
2024-08-01 16:04:16 +00:00
ed520580a1
Remove breadcrumbs for navigation ( #5676 )
...
Closes https://github.com/astral-sh/uv/issues/5671
These are effectively worthless since it never displays more than one
level.
2024-07-31 17:10:31 -05:00
9e4fbd2111
Move pip-compatibility doc into pip interface section ( #5670 )
2024-07-31 20:30:10 +00:00
89947681d1
Improve copy of console command examples ( #5397 )
...
## Summary
This PR improves the copy of the console command example by:
- Preventing the selection of generic prompts and generic output
- Lazily setting copy content by leveraging intersection observer
Most of the changes are inspired by
https://github.com/opensafely/documentation/pull/1461
Some other useful refs:
- https://github.com/squidfunk/mkdocs-material/issues/3647
-
https://mkdocstrings.github.io/recipes/#prevent-selection-of-prompts-and-output-in-python-code-blocks
Resolves #5355
## Test Plan
-
``` shell-session
mkdocs serve -f mkdocs.public.yml
```
- Navigate to http://localhost:8000/uv/first-steps/#viewing-the-version
- Try clicking the copy button
- Try copying by selecting the content
---------
Co-authored-by: Zanie Blue <contact@zanie.dev >
2024-07-31 14:52:02 +00:00
5830a532ef
Add links to documentation footer ( #5616 )
2024-07-30 12:42:17 -05:00
6eb8f85668
Update documentation sections ( #5452 )
...
Reframes "the low-level interface" as "the pip interface"
Adds indexes to all sections
Renames "commercial indexes" to "alternative indexes"
2024-07-25 12:37:22 -05:00
3581e27cdf
Bundle of docs changes ( #5426 )
2024-07-24 17:10:33 -05:00
ac81036aa9
Use logo in documentation ( #5421 )
...
Before
<img width="728" alt="Screenshot 2024-07-24 at 3 12 28 PM"
src="https://github.com/user-attachments/assets/2ad83857-a2a5-4c33-9fb2-f2580ccb10af ">
After
<img width="728" alt="Screenshot 2024-07-24 at 3 11 07 PM"
src="https://github.com/user-attachments/assets/dd209d37-3761-4b28-8ca9-9bf7546236a8 ">
Alternatively
<img width="728" alt="Screenshot 2024-07-24 at 3 10 45 PM"
src="https://github.com/user-attachments/assets/88f9cc62-71ec-457c-b946-3168502d46c3 ">
2024-07-24 15:45:10 -05:00
dac696e950
Bundle of documentation changes ( #5307 )
...
Following #5239
2024-07-23 13:29:59 -05:00
6492f1a897
A bundle of documentation changes ( #5239 )
...
I just need to iterate on everything and we're not doing a lot of
reviews anyway.
Closes #5234
Closes #5191
2024-07-22 17:15:11 +00:00
583a6e57f2
Write tools concept doc ( #5207 )
2024-07-19 14:24:43 -05:00
61a81da760
Move integration guide docs and edit Azure integration guide ( #5117 )
2024-07-18 03:47:32 +00:00
177bbaa8c0
Add stubs for the project documentation ( #5135 )
...
@ibraheemdev is going to do some work on these, I just sketched out some
parts to try to understand how things will fit together.
2024-07-16 17:02:54 -05:00
21cda3e079
Separate the TOC from the navigation bar ( #5128 )
...
Starting a discussion.
I find the navigation bar too long and verbose, it's overwhelming. I
think we either need to either:
- Limit the depth of the navigation bar (i.e. via `toc_depth: 2`)
- Move the table of contents out of the navigation bar over to the right
side
I prefer the second, though I think we ought to do some styling to
improve the aesthetics.
2024-07-16 16:11:35 -05:00
545bbf9286
Add settings.md to docs ( #5091 )
...
## Summary
It's kinda messed up: the depths are off, and the titles are incorrectly
uppercased, but I'll fix those tomorrow.
2024-07-16 02:46:21 +00:00
e61a221fef
Migrate from MdBook to MkDocs ( #5062 )
...
## Summary
We want to have consistency between the Ruff and uv documentation for
the upcoming release. We don't love the Ruff docs, but we'd rather have
consistency and then work towards improving them both, rather than have
two very-different documentation sites that both have weaknesses.
The setup here is simpler than in Ruff as: (1) we don't yet generate any
docs from Rust and (2) we don't try to reuse the README in the uv
documentation (which adds a lot of complexity in Ruff). So the change
here is mostly a 1-to-1 port to MkDocs.
## Test Plan
2024-07-15 22:22:07 +00:00
Zanie Blue