Skip to content

Commit 675dd2f

Browse files
committed
enable non-standard docslink
1 parent eb2ca80 commit 675dd2f

2 files changed

Lines changed: 15 additions & 9 deletions

File tree

docs/contributing.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,8 @@ The `PkgInfo` struct has seven fields, and can be defined with kwargs:
124124
* `docslink` (optional, default: `"https://$username.github.io/$pkgname.jl"`)
125125
* URL to the documentation.
126126
* Set `nothing` if the package does not have documentation.
127-
* Note that `$docslink/dev` and `$docslink/stable` will be used in the documentation.
127+
* By default both `$docslink/dev` and `$docslink/stable` will be used in the documentation.
128+
* To get only a single documentation link, set a `docslink` that ends on "/". Then that URL is used as link to the docs (e.g. `docslink="https://eben60.github.io/Mendeleev.jl/"`).
128129
* `codecovlink` (optional, default: `"https://codecov.io/gh/$username/$pkgname.jl"`)
129130
* URL to codecov page.
130131
* Set `nothing` if the repository does not use CodeCov.

docs/utils.jl

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ const PKGINFOS = [
2020
PkgInfo(pkgname="Chain", username="jkrumbiegel", branch="master", docslink=nothing, codecovlink=nothing),
2121
PkgInfo(pkgname="Lazy", username="MikeInnes", branch="master", docslink=nothing, codecovlink=nothing),
2222
PkgInfo(pkgname="Pipe", username="oxinabox", branch="master", docslink=nothing, codecovlink=nothing),
23-
PkgInfo(pkgname="Unitful", username="PainterQubits", branch="master"),
23+
PkgInfo(pkgname="Unitful", username="JuliaPhysics", branch="master"),
2424
PkgInfo(pkgname="DynamicQuantities", username="SymbolicML", codecovlink=nothing),
2525
PkgInfo(pkgname="UnitSystems", username="chakravala", branch="master", docslink=nothing),
26-
PkgInfo(pkgname="Genie", username="GenieFramework", branch="master", codecovlink=nothing),
27-
PkgInfo(pkgname="Oxygen", username="ndortega", branch="master"),
28-
PkgInfo(pkgname="Bonito", username="SimonDanisch", branch="master"),
26+
PkgInfo(pkgname="Genie", username="GenieFramework", branch="master", codecovlink=nothing, docslink="https://GenieFramework.github.io/Genie.jl/dev/"),
27+
PkgInfo(pkgname="Oxygen", username="OxygenFramework", branch="master"),
28+
PkgInfo(pkgname="Bonito", username="SimonDanisch", branch="master", docslink="https://SimonDanisch.github.io/Bonito.jl/stable/"),
2929
PkgInfo(pkgname="Plots", username="JuliaPlots", branch="master", docslink="https://docs.juliaplots.org/", codecovlink=nothing),
3030
PkgInfo(pkgname="Makie", username="MakieOrg", branch="master", docslink="https://docs.makie.org/", codecovlink=nothing),
3131
PkgInfo(pkgname="AlgebraOfGraphics", username="MakieOrg", branch="master", codecovlink=nothing),
@@ -71,7 +71,7 @@ const PKGINFOS = [
7171
PkgInfo(pkgname="TetGen", username="JuliaGeometry", branch="master"),
7272
PkgInfo(pkgname="GMT", username="GenericMappingTools", branch="master"),
7373
PkgInfo(pkgname="PkgTemplates", username="JuliaCI", branch="master"),
74-
PkgInfo(pkgname="PkgSkeleton", username="tpapp", branch="master"),
74+
PkgInfo(pkgname="PkgSkeleton", username="tpapp", branch="master", docslink=nothing),
7575
PkgInfo(pkgname="Pkg", username="JuliaLang", branch="master"),
7676
PkgInfo(pkgname="PyCall", username="JuliaPy", branch="master"),
7777
PkgInfo(pkgname="PythonCall", username="JuliaPy"),
@@ -170,9 +170,14 @@ function hfun_badge(args)
170170
codecovlink = pkginfo.codecovlink
171171
registered = pkginfo.registered
172172

173-
html_docs = isnothing(docslink) ? "" : """
174-
<a href="$docslink/stable"><img src="https://img.shields.io/badge/docs-stable-blue.svg" alt="Stable"></a>
175-
<a href="$docslink/dev"><img src="https://img.shields.io/badge/docs-dev-blue.svg" alt="Dev"></a>
173+
docreg = r".*/([^/]+)/$"
174+
isnothing(docslink) || (docmatch = match(docreg, docslink))
175+
html_docs = isnothing(docslink) ? "" :
176+
isnothing(docmatch) ? """
177+
<a href="$docslink/stable"><img src="https://img.shields.io/badge/docs-stable-blue.svg" alt="Stable"></a>
178+
<a href="$docslink/dev"><img src="https://img.shields.io/badge/docs-dev-blue.svg" alt="Dev"></a>
179+
""" : """
180+
<a href="$docslink"><img src="https://img.shields.io/badge/docs-$(docmatch[1])-blue.svg" alt="Doc"></a>
176181
"""
177182
html_codecov = isnothing(codecovlink) ? "" : """
178183
<a href="$codecovlink"><img src="$codecovlink/branch/$branch/graph/badge.svg" alt="Coverage"></a>

0 commit comments

Comments
 (0)