Skip to content

Commit

Permalink
docs with examples should compile now
Browse files Browse the repository at this point in the history
  • Loading branch information
chmerdon committed Nov 5, 2024
1 parent 6ef6c47 commit 94dc9f4
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 11 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
9 changes: 4 additions & 5 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ using CairoMakie
function make_all(; with_examples::Bool = true)

module_examples = []
pluto_examples = []
pluto_examples = []

if with_examples

Expand Down Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion examples/Example200_LowLevelPoisson.jl
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/Example205_LowLevelSpaceTimePoisson.jl
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/Example210_LowLevelNavierStokes.jl
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/Example280_BasisPlotter.jl
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
2 changes: 1 addition & 1 deletion examples/Example281_DiscontinuousPlot.jl
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion examples/Example290_InterpolationBetweenMeshes.jl
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

2 comments on commit 94dc9f4

@chmerdon
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/118718

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.8.1 -m "<description of version>" 94dc9f440911c55a6a5ebf5a03a23b7ddf5f458d
git push origin v0.8.1

Please sign in to comment.