Skip to content

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

Merged
lkdvos merged 3 commits into
mainfrom
ld-citations
Oct 5, 2026
Merged

lkdvos merged 3 commits into
mainfrom
ld-citations

Conversation

@lkdvos

@lkdvos lkdvos commented Oct 5, 2026

Copy link
Copy Markdown
Member

Description

Documentation citations render correctly with DocumenterVitepress 0.3.7 and DocumenterCitations 1.5. Raise their minimum compat versions to ensure that support is available.

Disable citation hover previews with show_hover = false until DocumenterVitepress.jl#399 is released, and link that PR in a TODO. This avoids broken citation rendering in lists and API docstrings while preserving author–year citations and clickable bibliography links, without maintaining a local Vue component or configuration plugin.

Validation

  • Draft documentation build passed with DocumenterVitepress 0.3.7 and DocumenterCitations 1.5.0.
  • Verified all 42 reference links in the generated HTML resolve to bibliography anchors; no raw citation markup or hover wrappers remain.
  • git diff --check passed.
  • Numerical examples and doctests were skipped for this documentation rendering check.

Checklist

  • Relevant documentation build and citation rendering checks pass locally
  • Documentation configuration updated; no public API changes
  • Runic formatter is run (not run; changes are dependency bounds and a documentation configuration option)
  • Changelog entry added (documentation infrastructure only)

@lkdvos lkdvos added the documentation Improvements or additions to documentation label Oct 5, 2026
@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

After the build completes, the updated documentation will be available here

@lkdvos
lkdvos merged commit 412d46d into main Oct 5, 2026
4 of 72 checks passed
@lkdvos
lkdvos deleted the ld-citations branch October 5, 2026 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant