Skip to content

[docs] Clarify use of DocumenterTools.genkeys for out-of-repo deployment #2815

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
giordano wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[docs] Clarify use of DocumenterTools.genkeys for out-of-repo deployment #2815

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/man/hosting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@ In those cases, it can be useful to deploy the docs in the `gh-pages` of a separ
The following steps can be used to deploy the documentation of a "source"
repository on a "target" repo:

1. Run `DocumenterTools.genkeys()` to generate a pair of keys
1. Run `DocumenterTools.genkeys(; user="TargetRepoOrg", repo="TargetRepo")` to generate a pair of keys
2. Add the **deploy key** to the **"target"** repository
3. Add the `DOCUMENTER_KEY` **secret** to the **"source"** repository (that runs the documentation workflow)
4. Adapt `docs/make.jl` to deploy on "target" repository:
Expand Down
Loading