From e01ed595106dd1f8e5f5ed11c9cbcd941317b528 Mon Sep 17 00:00:00 2001 From: mtfishman Date: Tue, 3 Mar 2026 22:03:15 -0500 Subject: [PATCH] Apply shared_docs_and_tests_workflows patch --- Project.toml | 2 +- docs/Project.toml | 2 ++ docs/make.jl | 2 +- docs/make_index.jl | 21 ------------- docs/make_readme.jl | 17 ---------- test/Project.toml | 2 ++ test/runtests.jl | 76 ++------------------------------------------- 7 files changed, 8 insertions(+), 114 deletions(-) delete mode 100644 docs/make_index.jl delete mode 100644 docs/make_readme.jl diff --git a/Project.toml b/Project.toml index 2cc6bfe1..26867579 100644 --- a/Project.toml +++ b/Project.toml @@ -1,6 +1,6 @@ name = "ITensorDocsNext" uuid = "701fd796-f527-45da-9a53-2681c1a90c45" -version = "0.1.14" +version = "0.1.15" authors = ["ITensor developers and contributors"] [workspace] diff --git a/docs/Project.toml b/docs/Project.toml index a1748761..bda9eac0 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -2,6 +2,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" DocumenterMermaid = "a078cd44-4d9c-4618-b545-3ab9d77f9177" ITensorDocsNext = "701fd796-f527-45da-9a53-2681c1a90c45" +ITensorFormatter = "b6bf39f1-c9d3-4bad-aad8-593d802f65fd" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" MultiDocumenter = "87ed4bf0-c935-4a67-83c3-2a03bee4197c" @@ -12,5 +13,6 @@ path = ".." Documenter = "1.9" DocumenterMermaid = "0.2" ITensorDocsNext = "0.1" +ITensorFormatter = "0.2.27" Literate = "2.20.1" MultiDocumenter = "0.8" diff --git a/docs/make.jl b/docs/make.jl index 79e45c39..3b05e07e 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -19,7 +19,7 @@ Building aggregate site into: $(outpath) """ @info "Building Documenter site for ITensorDocsNext" -include("make_index.jl") +ITensorFormatter.make_index!(pkgdir(ITensorDocsNext)) Documenter.makedocs(; sitename = "ITensor ecosystem docs", modules = [ITensorDocsNext], diff --git a/docs/make_index.jl b/docs/make_index.jl deleted file mode 100644 index f8d12ee4..00000000 --- a/docs/make_index.jl +++ /dev/null @@ -1,21 +0,0 @@ -using ITensorDocsNext: ITensorDocsNext -using Literate: Literate - -function ccq_logo(content) - include_ccq_logo = """ - ```@raw html - Flatiron Center for Computational Quantum Physics logo. - Flatiron Center for Computational Quantum Physics logo. - ``` - """ - content = replace(content, "{CCQ_LOGO}" => include_ccq_logo) - return content -end - -Literate.markdown( - joinpath(pkgdir(ITensorDocsNext), "examples", "README.jl"), - joinpath(pkgdir(ITensorDocsNext), "docs", "src"); - flavor = Literate.DocumenterFlavor(), - name = "index", - postprocess = ccq_logo -) diff --git a/docs/make_readme.jl b/docs/make_readme.jl deleted file mode 100644 index 02eed8b2..00000000 --- a/docs/make_readme.jl +++ /dev/null @@ -1,17 +0,0 @@ -using Literate: Literate - -let inputfile = joinpath(@__DIR__, "..", "examples", "README.jl"), - outputdir = joinpath(@__DIR__, ".."), flavor = Literate.CommonMarkFlavor(), - name = "README" - - function postprocess(content) - include_ccq_logo = """ - - - Flatiron Center for Computational Quantum Physics logo. - - """ - return replace(content, "{CCQ_LOGO}" => include_ccq_logo) - end - Literate.markdown(inputfile, outputdir; flavor, name, postprocess) -end diff --git a/test/Project.toml b/test/Project.toml index 16fae5f9..46efbb49 100644 --- a/test/Project.toml +++ b/test/Project.toml @@ -1,6 +1,7 @@ [deps] Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595" ITensorDocsNext = "701fd796-f527-45da-9a53-2681c1a90c45" +ITensorPkgSkeleton = "3d388ab1-018a-49f4-ae50-18094d5f71ea" SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f" Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb" Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" @@ -11,6 +12,7 @@ path = ".." [compat] Aqua = "0.8.9" ITensorDocsNext = "0.1" +ITensorPkgSkeleton = "0.3.40" SafeTestsets = "0.1" Suppressor = "0.2" Test = "1.10" diff --git a/test/runtests.jl b/test/runtests.jl index e5afded7..05baac8a 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -1,75 +1,3 @@ -using SafeTestsets: @safetestset -using Suppressor: Suppressor +using ITensorPkgSkeleton: ITensorPkgSkeleton -# check for filtered groups -# either via `--group=ALL` or through ENV["GROUP"] -const pat = r"(?:--group=)(\w+)" -arg_id = findfirst(contains(pat), ARGS) -const GROUP = uppercase( - if isnothing(arg_id) - arg = get(ENV, "GROUP", "ALL") - # For some reason `ENV["GROUP"]` is set to `""` - # when running via GitHub Actions, so handle that case: - arg == "" ? "ALL" : arg - else - only(match(pat, ARGS[arg_id]).captures) - end -) - -""" -match files of the form `test_*.jl`, but exclude `*setup*.jl` -""" -function istestfile(path) - fn = basename(path) - return endswith(fn, ".jl") && startswith(basename(fn), "test_") && - !contains(fn, "setup") -end -""" -match files of the form `*.jl`, but exclude `*_notest.jl` and `*setup*.jl` -""" -function isexamplefile(path) - fn = basename(path) - return endswith(fn, ".jl") && !endswith(fn, "_notest.jl") && !contains(fn, "setup") -end - -@time begin - # tests in groups based on folder structure - for testgroup in filter(isdir, readdir(@__DIR__; join = true)) - if GROUP == "ALL" || GROUP == uppercase(basename(testgroup)) - for filename in filter(istestfile, readdir(testgroup; join = true)) - @eval @safetestset $(basename(filename)) begin - include($filename) - end - end - end - end - - # single files in top folder - for file in filter(istestfile, readdir(@__DIR__; join = true)) - (basename(file) == basename(@__FILE__)) && continue # exclude this file to avoid infinite recursion - @eval @safetestset $(basename(file)) begin - include($file) - end - end - - # test examples - examplepath = joinpath(@__DIR__, "..", "examples") - for (root, _, files) in walkdir(examplepath) - contains(chopprefix(root, @__DIR__), "setup") && continue - for file in filter(isexamplefile, files) - filename = joinpath(root, file) - @eval begin - @safetestset $file begin - $( - Expr( - :macrocall, - GlobalRef(Suppressor, Symbol("@suppress")), - LineNumberNode(@__LINE__, @__FILE__), - :(include($filename)) - ) - ) - end - end - end - end -end +ITensorPkgSkeleton.runtests(; testdir = @__DIR__)