From 94dc9f440911c55a6a5ebf5a03a23b7ddf5f458d Mon Sep 17 00:00:00 2001 From: Christian Merdon Date: Tue, 5 Nov 2024 08:44:42 +0100 Subject: [PATCH] docs with examples should compile now --- CHANGELOG.md | 5 +++++ docs/make.jl | 9 ++++----- examples/Example200_LowLevelPoisson.jl | 2 +- examples/Example205_LowLevelSpaceTimePoisson.jl | 2 +- examples/Example210_LowLevelNavierStokes.jl | 2 +- examples/Example280_BasisPlotter.jl | 2 +- examples/Example281_DiscontinuousPlot.jl | 2 +- examples/Example290_InterpolationBetweenMeshes.jl | 2 +- 8 files changed, 15 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0eaac48..f6972e2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # CHANGES + +## v0.8.1 November 4, 2024 + - fixed dimension in nodevals output (xdim was determined wrongly and caused huge arrays) + - examples in the documentation reactivated + ## v0.8 November 1, 2024 - started changelog - fist registered version since repository move (fixed some URL links in the doc and readme) diff --git a/docs/make.jl b/docs/make.jl index 389cdd7..4f6b7b8 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -8,7 +8,7 @@ using CairoMakie function make_all(; with_examples::Bool = true) module_examples = [] - pluto_examples = [] + pluto_examples = [] if with_examples @@ -43,12 +43,11 @@ function make_all(; with_examples::Bool = true) modules=[ExtendableFEMBase], sitename="ExtendableFEMBase.jl", authors="Christian Merdon", - repo = "https://github.com/WIAS-PDELib/ExtendableFEMBase.jl", - clean = true, - format = Documenter.HTML(size_threshold = 250000, mathengine = MathJax3()), + format = Documenter.HTML(repolink = "https://github.com/WIAS-PDELib/ExtendableFEMBase.jl", size_threshold = 250000, mathengine = MathJax3()), + clean = false, checkdocs = :all, warnonly = false, - doctest = true, + doctest = false, pages = [ "Home" => "index.md", "Index" => "package_index.md", diff --git a/examples/Example200_LowLevelPoisson.jl b/examples/Example200_LowLevelPoisson.jl index 42ccc10..3bec6eb 100644 --- a/examples/Example200_LowLevelPoisson.jl +++ b/examples/Example200_LowLevelPoisson.jl @@ -1,7 +1,7 @@ #= # 200 : Poisson Problem -([source code](SOURCE_URL)) +([source code](@__SOURCE_URL__)) This example computes the solution ``u`` of the two-dimensional Poisson problem ```math diff --git a/examples/Example205_LowLevelSpaceTimePoisson.jl b/examples/Example205_LowLevelSpaceTimePoisson.jl index bd45156..ee11833 100644 --- a/examples/Example205_LowLevelSpaceTimePoisson.jl +++ b/examples/Example205_LowLevelSpaceTimePoisson.jl @@ -1,7 +1,7 @@ #= # 205 : Space-Time FEM for Poisson Problem -([source code](SOURCE_URL)) +([source code](@__SOURCE_URL__)) This example computes the solution ``u`` of the two-dimensional heat equation diff --git a/examples/Example210_LowLevelNavierStokes.jl b/examples/Example210_LowLevelNavierStokes.jl index 318477c..7153a29 100644 --- a/examples/Example210_LowLevelNavierStokes.jl +++ b/examples/Example210_LowLevelNavierStokes.jl @@ -1,7 +1,7 @@ #= # 210 : Navier-Stokes Problem -([source code](SOURCE_URL)) +([source code](@__SOURCE_URL__)) Consider the Navier-Stokes problem that seeks ``u`` and ``p`` such that ```math diff --git a/examples/Example280_BasisPlotter.jl b/examples/Example280_BasisPlotter.jl index 7421fb8..05132ac 100644 --- a/examples/Example280_BasisPlotter.jl +++ b/examples/Example280_BasisPlotter.jl @@ -1,7 +1,7 @@ #= # 280 : Basis-Plotter -([source code](SOURCE_URL)) +([source code](@__SOURCE_URL__)) This example plots all the basis functions of a H1 finite element on Edge1D or Triangle2D as unicode plots. This is the result with the default parameters (dim = 1, order = 3): diff --git a/examples/Example281_DiscontinuousPlot.jl b/examples/Example281_DiscontinuousPlot.jl index 5769628..e400f6d 100644 --- a/examples/Example281_DiscontinuousPlot.jl +++ b/examples/Example281_DiscontinuousPlot.jl @@ -1,7 +1,7 @@ #= # 281 : Discontinuous Plot -([source code](SOURCE_URL)) +([source code](@__SOURCE_URL__)) This example demonstrates how to plot a discontinuous function on a grid with two regions by region-wise nodal values and plotting. diff --git a/examples/Example290_InterpolationBetweenMeshes.jl b/examples/Example290_InterpolationBetweenMeshes.jl index 44ce750..6946175 100644 --- a/examples/Example290_InterpolationBetweenMeshes.jl +++ b/examples/Example290_InterpolationBetweenMeshes.jl @@ -1,7 +1,7 @@ #= # 290 : Interpolation Between Meshes -([source code](SOURCE_URL)) +([source code](@__SOURCE_URL__)) This example demonstrates the interpolation between meshes feature. Here, we interpolate a function with the P2 element of a coarse triangulation and then interpolate this P2 function on two uniform refinements into some P1 function. Then, both finite element functions are plotted.