search

trixi-framework / TrixiBase.jl

Common functionality used by multiple Julia packages in the Trixi Framework
https://trixi-framework.github.io/TrixiBase.jl/
MIT License
5 stars 3 forks source link

Doctests of `trixi_include` fail #12

Closed JoshuaLampert closed 8 months ago

JoshuaLampert commented 8 months ago

The doctest of trixi_include fail because examples_dir() is not defined although I set

DocMeta.setdocmeta!(TrixiBase, :DocTestSetup, :(using TrixiBase); recursive = true)

What can I do such that this works or if there is no (easy) way, what should we do?

efaulhaber commented 8 months ago

IMO it doesn't really make sense to have a Trixi example in the TrixiBase docs.

But I can't think of a good way to demonstrate trixi_include otherwise. Writing a file first seems more complicated than relying on Trixi.

JoshuaLampert commented 8 months ago

What if we just make it a usual example, but remove the jldoctest?