From f15191aad07c3d0a3d67b4ce45093fe66494c937 Mon Sep 17 00:00:00 2001 From: Benjamin Lorenz Date: Mon, 24 Jul 2023 12:34:57 +0200 Subject: [PATCH] wip: monkeypatch documenter into printing blocks and timings --- .github/workflows/CI.yml | 3 ++- docs/documenter_helpers.jl | 7 +++++++ docs/make_work.jl | 2 ++ 3 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 docs/documenter_helpers.jl diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 5e707efa0d9e..fd76b980453b 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -25,6 +25,7 @@ jobs: julia-version: - '1.9' - '~1.10.0-0' + - 'nightly' os: - ubuntu-latest @@ -58,12 +59,12 @@ jobs: julia --project=docs --color=yes -e ' using Pkg Pkg.develop(PackageSpec(path=pwd())) - Pkg.add(url="https://github.com/benlorenz/Documenter.jl", rev="bl/printblockandtime027") Pkg.instantiate()' - name: "Run doctests" run: | julia --project=docs --depwarn=error --color=yes -e' using Documenter + include("docs/documenter_helpers.jl") using Oscar DocMeta.setdocmeta!(Oscar, :DocTestSetup, :(using Oscar; Oscar.AbstractAlgebra.set_current_module(@__MODULE__)); recursive = true) doctest(Oscar)' diff --git a/docs/documenter_helpers.jl b/docs/documenter_helpers.jl new file mode 100644 index 000000000000..29fb4befb8b9 --- /dev/null +++ b/docs/documenter_helpers.jl @@ -0,0 +1,7 @@ + + +function Documenter.DocTests.eval_repl(block, sandbox::Module, meta::Dict, doc::Documenter.Documents.Document, page) + src_lines = Documenter.Utilities.find_block_in_file(block.code, meta[:CurrentFile]) + println("page: $(Documenter.Utilities.locrepr(meta[:CurrentFile], src_lines))") + @time invoke(Documenter.DocTests.eval_repl, Tuple{Any,Any,Dict,Documenter.Documents.Document,Any}, block, sandbox, meta, doc, page) +end diff --git a/docs/make_work.jl b/docs/make_work.jl index edefe96a7ff1..4ee770c5a078 100644 --- a/docs/make_work.jl +++ b/docs/make_work.jl @@ -6,6 +6,8 @@ module BuildDoc using Documenter, DocumenterCitations +include("documenter_helpers.jl") + # Overwrite printing to make the header not full of redundant nonsense # Turns # Hecke.Order - Method