Skip to content

Fix documentation citations and disable hover previews pending upstream support #534

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

Merged
lkdvos merged 3 commits into from
Oct 5, 2026
Merged

Fix documentation citations and disable hover previews pending upstream support #534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
03610c8
Raise minimum documentation citation dependencies
lkdvos Oct 5, 2026
22069a0
Fix citation hover previews in documentation
lkdvos Oct 5, 2026
c8465b0
Disable citation hover previews pending upstream fix
lkdvos Oct 5, 2026
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
3 changes: 2 additions & 1 deletion docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ MPSKit = {path = ".."}

[compat]
Documenter = "1.11"
DocumenterCitations = "1.5"
DocumenterInterLinks = "1"
DocumenterVitepress = "0.3"
DocumenterVitepress = "0.3.7"
4 changes: 3 additions & 1 deletion docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ end

# bibliography
bibpath = joinpath(@__DIR__, "src", "assets", "mpskit.bib")
bib = CitationBibliography(bibpath; style = :authoryear)
# TODO: Re-enable hover previews once the upstream fix is released:
# https://github.com/LuxDL/DocumenterVitepress.jl/pull/399
bib = CitationBibliography(bibpath; style = :authoryear, show_hover = false)

# interlinks
links = InterLinks(
Expand Down
2 changes: 1 addition & 1 deletion docs/src/.vitepress/theme/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ export const Theme: ThemeConfig = {
app.component('Authors', Authors)
}
}
export default Theme
export default Theme
Loading