From 94a6b8dcc196344d4f405e8a5a4c2ce649af8507 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Fuhrmann?= Date: Tue, 23 Jul 2024 14:40:40 +0200 Subject: [PATCH 1/4] Hint on registering generated documentation with DocumentationGeneratorRegistry Registering with DocumentationGeneratorRegistry ensures that Github points to the documentation version hosted on the package repo rather than to a possibly stripped-down version. --- docs/src/man/hosting.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/src/man/hosting.md b/docs/src/man/hosting.md index af3572ec42..f712951f7a 100644 --- a/docs/src/man/hosting.md +++ b/docs/src/man/hosting.md @@ -441,6 +441,16 @@ 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//.jl/settings/actions`. +## JuliaHub + +JuliaHub provides an [overview on registered Julia packages](https://https://juliahub.com/ui/Packages). +It tries to build package documentation on it's own, 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 thehosted documentation with +[DocumentationGeneratorRegistry](https://github.com/JuliaDocs/DocumentationGeneratorRegistry). + + ## Woodpecker CI To run a documentation build from Woodpecker CI, one should create an access token From e6fc6ded8f78398a5bc8188293a4389ac1b91e21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Fuhrmann?= Date: Fri, 2 Aug 2024 11:02:27 +0200 Subject: [PATCH 2/4] Update JuliaHub hint The link on JuliaHub is updated after releasing a new package version. (tested) --- docs/src/man/hosting.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/src/man/hosting.md b/docs/src/man/hosting.md index f712951f7a..eff63ffb03 100644 --- a/docs/src/man/hosting.md +++ b/docs/src/man/hosting.md @@ -443,12 +443,13 @@ an alternative is to give GitHub workflows write permissions under the repo sett ## JuliaHub -JuliaHub provides an [overview on registered Julia packages](https://https://juliahub.com/ui/Packages). +[JuliaHub](https://juliahub.com/ui/Home) provides an [overview on registered Julia packages](https://https://juliahub.com/ui/Packages). It tries to build package documentation on it's own, if this fails, a stripped down version of the documentation -is generated which just consists of the README and the docstrings of the package. +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 thehosted documentation with +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 From 243a217102659cad7d7388f9143c21a631d32424 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Fuhrmann?= Date: Sat, 3 Aug 2024 12:27:05 +0200 Subject: [PATCH 3/4] Update docs/src/man/hosting.md Co-authored-by: Daniel VandenHeuvel <95613936+DanielVandH@users.noreply.github.com> --- docs/src/man/hosting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/man/hosting.md b/docs/src/man/hosting.md index eff63ffb03..730b2afe98 100644 --- a/docs/src/man/hosting.md +++ b/docs/src/man/hosting.md @@ -444,7 +444,7 @@ an alternative is to give GitHub workflows write permissions under the repo sett ## JuliaHub [JuliaHub](https://juliahub.com/ui/Home) provides an [overview on registered Julia packages](https://https://juliahub.com/ui/Packages). -It tries to build package documentation on it's own, if this fails, a stripped down version of the documentation +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 From 75f818f8e8a92533ed0928070c22574e3d18101a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Fuhrmann?= Date: Wed, 7 Aug 2024 14:02:38 +0200 Subject: [PATCH 4/4] overview of --- docs/src/man/hosting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/man/hosting.md b/docs/src/man/hosting.md index 730b2afe98..8be0e52ffc 100644 --- a/docs/src/man/hosting.md +++ b/docs/src/man/hosting.md @@ -443,7 +443,7 @@ an alternative is to give GitHub workflows write permissions under the repo sett ## JuliaHub -[JuliaHub](https://juliahub.com/ui/Home) provides an [overview on registered Julia packages](https://https://juliahub.com/ui/Packages). +[JuliaHub](https://juliahub.com/ui/Home) provides an [overview of registered Julia packages](https://https://juliahub.com/ui/Packages). 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