Skip to content

Render code blocks with DocumenterCodeBlocks - #742

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.

[only docs]
@codecov

codecov Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.33%. Comparing base (abe0122) to head (196dab8).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #742   +/-   ##
=======================================
  Coverage   84.33%   84.33%           
=======================================
  Files          55       55           
  Lines        4979     4979           
=======================================
  Hits         4199     4199           
  Misses        780      780           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions

Copy link
Copy Markdown
Contributor

Documentation preview: https://juliagpu.github.io/oneAPI.jl/previews/PR742/

@maleadt
maleadt merged commit 584af0b into main Oct 25, 2026
5 checks passed
@maleadt
maleadt deleted the tb/codeblocks branch October 25, 2026 18:03
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