Skip to content

Render code blocks with DocumenterCodeBlocks - #709

Merged
maleadt merged 1 commit into
mainfrom
tb/codeblocks
Oct 25, 2026
Merged

maleadt merged 1 commit into
mainfrom
tb/codeblocks

Conversation

@maleadt

@maleadt maleadt commented Oct 25, 2026

Copy link
Copy Markdown
Member

Adds the DocumenterCodeBlocks.jl plugin to the documentation build, as done in JuliaGPU/KernelAbstractions.jl#917. Julia code blocks are now highlighted at build time, get linkable line numbers, and link identifiers to their docstrings with hover tooltips.

The plugin relies on Documenter internals, so a future Documenter release may need a matching DocumenterCodeBlocks update.

The plugin highlights Julia code at build time, adds linkable line numbers,
and links identifiers in code blocks to their docstrings with hover tooltips.
The configuration matches the one in KernelAbstractions.jl.
@github-actions

Copy link
Copy Markdown
Contributor

Documentation preview: https://juliallvm.github.io/LLVM.jl/previews/PR709/

@codecov

codecov Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@           Coverage Diff           @@
##             main     #709   +/-   ##
=======================================
  Coverage   94.34%   94.34%           
=======================================
  Files          59       59           
  Lines        7922     7922           
=======================================
  Hits         7474     7474           
  Misses        448      448           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@maleadt
maleadt merged commit 3f95688 into main Oct 25, 2026
63 checks passed
@maleadt
maleadt deleted the tb/codeblocks branch October 25, 2026 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant