Update documentation for charlie/docs-repo#2
Closed
charliermarsh wants to merge 1 commit intomainfrom
Closed
Conversation
charliermarsh
added a commit
to astral-sh/uv
that referenced
this pull request
Jul 16, 2024
## Summary This approach is based on https://github.com/PrefectHQ/docs. Rather than publishing docs in the uv repo, we push to an independent repo that's used solely to house the docs. In Prefect's case, this allows them to publish versioned documentation (we should do that too). For us, though, the benefit is that we can publish the Ruff and uv docs as a single site (docs.astral.sh). Prefect clones the source repo and builds the documentation from the `docs` repo (i.e., the action runs in the `docs` repo). In our case, I've instead set it up such that the action runs in `uv` (and later in `ruff` too), clones the `docs` repo, and puts up a PR in that separate repo. Because of these requirements, we have to use a PAT rather than a deploy key (as PATs cannot do GitHub-specific things like create PRs -- they can only operate over the Git CLI). See: astral-sh/docs#2.
This file contains hidden or 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
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.
Automated documentation update for charlie/docs-repo