diff --git a/Changelog.md b/Changelog.md index 6c8357fd9d..1d587616e8 100644 --- a/Changelog.md +++ b/Changelog.md @@ -5,6 +5,12 @@ All notable Changes to the Julia package `Manopt.jl` will be documented in this The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.5.5] - unreleased + +### Added + +* icons upfront external links when they link to another package or wikipedia. + ## [0.5.4] - November 27, 2024 ### Added diff --git a/docs/make.jl b/docs/make.jl index 97e2699ac6..6167cc6593 100755 --- a/docs/make.jl +++ b/docs/make.jl @@ -145,7 +145,7 @@ links = InterLinks( makedocs(; format=Documenter.HTML(; prettyurls=run_on_CI || ("--prettyurls" ∈ ARGS), - assets=["assets/favicon.ico", "assets/citations.css"], + assets=["assets/favicon.ico", "assets/citations.css", "assets/link-icons.css"], size_threshold_warn=200 * 2^10, # raise slightly from 100 to 200 KiB size_threshold=300 * 2^10, # raise slightly 200 to to 300 KiB ), diff --git a/docs/src/assets/link-icons.css b/docs/src/assets/link-icons.css new file mode 100644 index 0000000000..a84137ac21 --- /dev/null +++ b/docs/src/assets/link-icons.css @@ -0,0 +1,42 @@ +a[href^="https://juliamanifolds.github.io/ManifoldsBase.jl/"]::before { + content: ""; + background-image: url('logo-manifoldsbase.png'); + background-size: contain; + background-repeat: no-repeat; + display: inline-block; + height: 1em; + width: 1em; + margin-right: 4px; + vertical-align: middle; +} +a[href^="https://juliamanifolds.github.io/Manifolds.jl/"]::before { + content: ""; + background-image: url('logo-manifolds.png'); + background-size: contain; + background-repeat: no-repeat; + display: inline-block; + height: 1em; + width: 1em; + margin-right: 4px; + vertical-align: middle; +} +a[href^="https://en.wikipedia.org/"]::before { + content: ""; + background-image: url('wikipedia.png'); + background-size: contain; + background-repeat: no-repeat; + display: inline-block; + height: 1em; + width: 1em; + margin-right: 4px; + vertical-align: middle; +} + +@media (prefers-color-scheme: dark) { + a[href^="https://juliamanifolds.github.io/ManifoldsBase.jl/"]::before { + background-image: url('logo-manifoldsbase-dark.png'); + } + a[href^="https://juliamanifolds.github.io/Manifolds.jl/"]::before { + background-image: url('logo-manifolds-dark.png'); + } +} \ No newline at end of file diff --git a/docs/src/assets/logo-manifolds-dark.png b/docs/src/assets/logo-manifolds-dark.png new file mode 100644 index 0000000000..5b10586644 Binary files /dev/null and b/docs/src/assets/logo-manifolds-dark.png differ diff --git a/docs/src/assets/logo-manifolds.png b/docs/src/assets/logo-manifolds.png new file mode 100644 index 0000000000..f9420161d2 Binary files /dev/null and b/docs/src/assets/logo-manifolds.png differ diff --git a/docs/src/assets/logo-manifoldsbase-dark.png b/docs/src/assets/logo-manifoldsbase-dark.png new file mode 100644 index 0000000000..ecfa190c36 Binary files /dev/null and b/docs/src/assets/logo-manifoldsbase-dark.png differ diff --git a/docs/src/assets/logo-manifoldsbase.png b/docs/src/assets/logo-manifoldsbase.png new file mode 100644 index 0000000000..a4e1dc5e25 Binary files /dev/null and b/docs/src/assets/logo-manifoldsbase.png differ diff --git a/docs/src/assets/wikipedia.png b/docs/src/assets/wikipedia.png new file mode 100644 index 0000000000..4dd204669d Binary files /dev/null and b/docs/src/assets/wikipedia.png differ diff --git a/src/documentation_glossary.jl b/src/documentation_glossary.jl index 31f051b386..5cf07ee491 100644 --- a/src/documentation_glossary.jl +++ b/src/documentation_glossary.jl @@ -357,7 +357,7 @@ define!( :grad_f, :description, (; M="M", p="p") -> - "the (Riemannian) gradient ``$(_tex(:grad))f``: $(_math(:M, M=M)) → $(_math(:TpM; M=M, p=p)) of f as a function `(M, p) -> X` or a function `(M, X, p) -> X` computing `X` in-place", + "the (Riemannian) gradient ``$(_tex(:grad))f: $(_math(:M, M=M)) → $(_math(:TpM; M=M, p=p))`` of f as a function `(M, p) -> X` or a function `(M, X, p) -> X` computing `X` in-place", ) define!( @@ -365,7 +365,7 @@ define!( :Hess_f, :description, (; M="M", p="p") -> - "the (Riemannian) Hessian ``$(_tex(:Hess))f``: $(_math(:TpM, M=M, p=p)) → $(_math(:TpM; M=M, p=p)) of f as a function `(M, p, X) -> Y` or a function `(M, Y, p, X) -> Y` computing `Y` in-place", + "the (Riemannian) Hessian ``$(_tex(:Hess))f: $(_math(:TpM, M=M, p=p)) → $(_math(:TpM; M=M, p=p))`` of f as a function `(M, p, X) -> Y` or a function `(M, Y, p, X) -> Y` computing `Y` in-place", ) define!(