Skip to content
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

Hint on registering generated documentation with DocumentationGeneratorRegistry #2548

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+11 −0
Open

Hint on registering generated documentation with DocumentationGeneratorRegistry #2548

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
94a6b8d
Hint on registering generated documentation with DocumentationGenerat…
j-fu Jul 23, 2024
e6fc6de
Update JuliaHub hint
j-fu Aug 2, 2024
243a217
Update docs/src/man/hosting.md
j-fu Aug 3, 2024
75f818f
overview of
j-fu Aug 7, 2024
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
11 changes: 11 additions & 0 deletions docs/src/man/hosting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,17 @@ The `permissions:` line above is described in the
an alternative is to give GitHub workflows write permissions under the repo settings, e.g.,
`https://github.com/<USER>/<REPO>.jl/settings/actions`.

## JuliaHub

[JuliaHub](https://juliahub.com/ui/Home) provides an [overview on registered Julia packages](https://https://juliahub.com/ui/Packages).
j-fu marked this conversation as resolved.
Show resolved Hide resolved
It tries to build package documentation on its own, and if this fails, a stripped down version of the documentation
is generated which just consists of the README and the docstrings of the package.
In order to point JuliaHub to the documentation already hosted e.g. on the `gh-pages` branch
of the package repository, it is possible to register the link to the hosted documentation with
[DocumentationGeneratorRegistry](https://github.com/JuliaDocs/DocumentationGeneratorRegistry).
The JuliaHub documentation link is updated after releasing a new package version.


## Woodpecker CI

To run a documentation build from Woodpecker CI, one should create an access token
Expand Down
Loading