Skip to content

Commit 21f282b

Browse files
Replace jldoctest by example (#13)
* replace jldoctest with example * format * Update src/trixi_include.jl Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com> * fix version of JuliaFormatter * use old formatting style again --------- Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
1 parent 152f794 commit 21f282b

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

.github/workflows/FormatCheck.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
#
2929
# julia -e 'using Pkg; Pkg.add(PackageSpec(name = "JuliaFormatter", version = "0.13.0"))'
3030
run: |
31-
julia -e 'using Pkg; Pkg.add(PackageSpec(name = "JuliaFormatter"))'
31+
julia -e 'using Pkg; Pkg.add(PackageSpec(name = "JuliaFormatter", version="1.0.45"))'
3232
julia -e 'using JuliaFormatter; format(".")'
3333
- name: Format check
3434
run: |

docs/make.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ copy_file("LICENSE.md",
3838
"\n" => "\n> ", r"^" => "# License\n\n> ")
3939

4040
# Make documentation
41-
makedocs(sitename = "TrixiBase.jl",
41+
makedocs(modules = [TrixiBase],
42+
sitename = "TrixiBase.jl",
4243
# Provide additional formatting options
4344
format = Documenter.HTML(
4445
# Disable pretty URLs during manual testing

src/trixi_include.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ for ODEs, see the "Miscellaneous" section of the
1818
1919
# Examples
2020
21-
```jldoctest
21+
```@example
22+
julia> using TrixiBase, Trixi
23+
2224
julia> redirect_stdout(devnull) do
2325
trixi_include(@__MODULE__, joinpath(examples_dir(), "tree_1d_dgsem", "elixir_advection_extended.jl"),
2426
tspan=(0.0, 0.1))

0 commit comments

Comments
 (0)