docs: migrate from Poetry to uv #4822
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
neongreen
commented
Nov 10, 2024
|
Thank you very much for working on this! As I mentioned in #4815 (comment) , I think this is the way to go. I'm not sure when I'll try this out and look at the details, but hopefully it won't take too long. Also, I'm curious if others decide to try it out in the meantime and see how well it works for them. |
4 tasks
martinvonz
reviewed
Nov 11, 2024
Done |
2 tasks
ilyagr
reviewed
Nov 15, 2024
ilyagr
reviewed
Nov 15, 2024
ilyagr
reviewed
Nov 15, 2024
ilyagr
reviewed
Nov 15, 2024
ilyagr
reviewed
Nov 15, 2024
ilyagr
added a commit
that referenced
this pull request
Nov 15, 2024
It just links to our actual docs and repeats the passage from README. This should cause GitHub to have a "Contributing" tab on https://github.com/martinvonz/jj, which will make these instrictions a lot easier to find. This will also hopefully mean that more people read the instructions on our website rather than GitHub, which will be a somewhat nicer experience after #4822.
ilyagr
added a commit
that referenced
this pull request
Nov 15, 2024
It just links to our actual docs and repeats the passage from README. This should cause GitHub to have a "Contributing" tab on https://github.com/martinvonz/jj, which will make these instrictions a lot easier to find. This will also hopefully mean that more people read the instructions on our website rather than GitHub, which will be a somewhat nicer experience after #4822.
ilyagr
added a commit
that referenced
this pull request
Nov 15, 2024
It just links to our actual docs and repeats the passage from README. This should cause GitHub to have a "Contributing" tab on https://github.com/martinvonz/jj, which will make these instrictions a lot easier to find. This will also hopefully mean that more people read the instructions on our website rather than GitHub, which will be a somewhat nicer experience after #4822.
ilyagr
added a commit
that referenced
this pull request
Nov 15, 2024
It just links to our actual docs and repeats the passage from README. This should cause GitHub to have a "Contributing" tab on https://github.com/martinvonz/jj, which will make these instrictions a lot easier to find. This will also hopefully mean that more people read the instructions on our website rather than GitHub, which will be a somewhat nicer experience after #4822.
ilyagr
added a commit
that referenced
this pull request
Nov 15, 2024
It just links to our actual docs and repeats the passage from README. This should cause GitHub to have a "Contributing" tab on https://github.com/martinvonz/jj, which will make these instrictions a lot easier to find. This will also hopefully mean that more people read the instructions on our website rather than GitHub, which will be a somewhat nicer experience after #4822.
ilyagr
added a commit
that referenced
this pull request
Nov 15, 2024
It just links to our actual docs and repeats the passage from README. This should cause GitHub to have a "Contributing" tab on https://github.com/martinvonz/jj, which will make these instrictions a lot easier to find. This will also hopefully mean that more people read the instructions on our website rather than GitHub, which will be a somewhat nicer experience after #4822.
ilyagr
added a commit
that referenced
this pull request
Nov 15, 2024
It just links to our actual docs and repeats the passage from README. I find that I often automatically scan for a `CONTRIBUTING.md` file in the repo and get annoyed when it's hard to find. This should be helped by the previus commit, but this will hopefully go further in putting everyone on a road leading to Rome as quickly as possible. This will also hopefully mean that more people read the instructions on our website rather than GitHub, which will be a somewhat nicer experience after #4822.
ilyagr
added a commit
that referenced
this pull request
Nov 15, 2024
It just links to our actual docs and repeats the passage from README. I find that I often automatically scan for a `CONTRIBUTING.md` file in the repo and get annoyed when it's hard to find. This should be helped by the previus commit, but this will hopefully go further in putting everyone on a road leading to Rome as quickly as possible. This will also hopefully mean that more people read the instructions on our website rather than GitHub, which will be a somewhat nicer experience after #4822.
ilyagr
added a commit
that referenced
this pull request
Nov 16, 2024
It just links to our actual docs and repeats the passage from README. I find that I often automatically scan for a `CONTRIBUTING.md` file in the repo and get annoyed when it's hard to find. This should be helped by the previus commit, but this will hopefully go further in putting everyone on a road leading to Rome as quickly as possible. This will also hopefully mean that more people read the instructions on our website rather than GitHub, which will be a somewhat nicer experience after #4822.
ilyagr
reviewed
Nov 16, 2024
ilyagr
reviewed
Nov 16, 2024
ilyagr
added a commit
that referenced
this pull request
Nov 16, 2024
People will often look for contributing instructions from https://github.com/martinvonz/jj, this makes it easier to find. It will also lead more people to read the contributing docs on the website as opposed to GitHub. This is becoming desireable, see the discussion at #4822 (comment)
ilyagr
reviewed
Nov 16, 2024
neongreen
force-pushed
the
emily/uv
branch
3 times, most recently
from
523d85e to
fce057d
Compare
ilyagr
reviewed
Nov 17, 2024
Our docs are built with MkDocs, which requires Python and several deps. Previously those deps were managed with Poetry, which is also written in Python. This commit replaces Poetry with `uv`, a Rust-based Python project/package manager, and thus removes several steps from the docs build process. Before: <install Python> <install pipx> pipx install poetry poetry install poetry run -- mkdocs serve After: <install uv> uv run mkdocs serve
|
@ilyagr I addressed everything, please check again |
|
LG, I like the restructuring. |
|
Do you need any more help from my GitHub admin role? |
|
For this PR — no.For the “publish docs preview” PR — please create a new environment, eg “preview” or “site-preview” or smth, and move DOCS_DEPLOY_KEY into that environment. You can create a new key if you don’t have it anymore. This is so that only the docs workflow has access to the key.On 19 Nov 2024, at 18:09, Martin von Zweigbergk ***@***.***> wrote:
Do you need any more help from my GitHub admin role?
—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you authored the thread.Message ID: ***@***.***>
|
ilyagr
approved these changes
Nov 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
If applicable:
CHANGELOG.mduvis a fast Python project manager written in Rust. It can automatically install Python, or use a global version if it satisfies the projects requirements.After the switch, contributors don't need to install Python to build the docs. The single command
uv run mkdocs servewill work.I also removed the Poetry-specific keyring workarounds. if someone uses the keyring to build the docs, I'd like them to try out this PR and report any issues.