Skip to content

use DocumenterCodeBlocks.jl #313

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
JoshuaLampert merged 7 commits into from
Aug 4, 2026
Merged

use DocumenterCodeBlocks.jl #313

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a7981c4
use DocumenterCodeBlocks.jl
ranocha Aug 4, 2026
536400b
fix julia codeblock
JoshuaLampert Aug 4, 2026
8dc0b34
Merge branch 'main' into hr/DocumenterCodeBlocks
JoshuaLampert Aug 4, 2026
aaff2da
fix capitalization
ranocha Aug 4, 2026
2544ab8
shorten first sentence of docstring
ranocha Aug 4, 2026
298b3fd
Merge branch 'hr/DocumenterCodeBlocks' of github.com:NumericalMathema…
ranocha Aug 4, 2026
168270c
shorten first sentence of docstring
ranocha Aug 4, 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
2 changes: 2 additions & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[deps]
Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterCodeBlocks = "b6400b83-267f-4b55-9fd8-bffc853bdfd8"
OrdinaryDiffEqTsit5 = "b1df2697-797e-41e3-8120-5422d3b24e4a"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
Expand All @@ -11,6 +12,7 @@ TrixiBase = "9a0f1c46-06d5-4909-a5a3-ce25d3fa3284"
[compat]
Changelog = "1"
Documenter = "1"
DocumenterCodeBlocks = "1.0"
OrdinaryDiffEqTsit5 = "1, 2"
Plots = "1.9"
Printf = "1"
Expand Down
4 changes: 4 additions & 0 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Documenter
using DocumenterCodeBlocks: CodeBlocks
using DispersiveShallowWater
using TrixiBase
using Changelog: Changelog
Expand Down Expand Up @@ -79,6 +80,9 @@ makedocs(;
assets = ["assets/favicon.ico"],
size_threshold = 1200 * 1024, # the generated .gif files can be too large
size_threshold_warn = 1000 * 1024),
# Improve code blocks in the documentation by using DocumenterCodeBlocks.jl
plugins = [CodeBlocks()],
# Explicitly specify documentation structure
pages = ["Home" => "index.md",
"Overview" => "overview.md",
"Basic Example" => "basic_example.md",
Expand Down
Loading