From 1644d47bd79170634f1fdf4d730d39933fd20d54 Mon Sep 17 00:00:00 2001 From: Martin Kunz Date: Wed, 20 Aug 2025 19:14:05 +0200 Subject: [PATCH 1/4] fix(docs): Update compat restriction for Documenter --- docs/Project.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Project.toml b/docs/Project.toml index 4ca9eda1..ba838d3e 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -3,4 +3,4 @@ AbstractFFTs = "621f4979-c628-5d54-868e-fcf4e3e8185c" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" [compat] -Documenter = "~0.25" +Documenter = "^1" From b2ecd7f37b7c633d8c4fc1d355bb6642190f6b5e Mon Sep 17 00:00:00 2001 From: Martin Kunz Date: Wed, 20 Aug 2025 19:24:16 +0200 Subject: [PATCH 2/4] fix(docs): Move the comment before `Base.adjoint` before docstring --- src/definitions.jl | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/definitions.jl b/src/definitions.jl index f4f1c196..eb9622a9 100644 --- a/src/definitions.jl +++ b/src/definitions.jl @@ -649,6 +649,9 @@ struct AdjointPlan{T,P<:Plan} <: Plan{T} AdjointPlan{T,P}(p) where {T,P} = new(p) end +# We eagerly form the plan inverse in the adjoint(p) call, which will be cached for subsequent calls. +# This is reasonable, as inv(p) would do the same, and necessary in order to compute the correct input +# type for the adjoint plan and encode it in its type. """ (p::Plan)' adjoint(p::Plan) @@ -659,9 +662,6 @@ Return a plan that performs the adjoint operation of the original plan. Adjoint plans do not currently support `LinearAlgebra.mul!`. Further, as a new addition to `AbstractFFTs`, coverage of `Base.adjoint` in downstream implementations may be limited. """ -# We eagerly form the plan inverse in the adjoint(p) call, which will be cached for subsequent calls. -# This is reasonable, as inv(p) would do the same, and necessary in order to compute the correct input -# type for the adjoint plan and encode it in its type. Base.adjoint(p::Plan{T}) where {T} = AdjointPlan{eltype(inv(p)), typeof(p)}(p) Base.adjoint(p::AdjointPlan) = p.p # always have AdjointPlan inside ScaledPlan. From ad05d926d187347aedb2268458d40482707feee5 Mon Sep 17 00:00:00 2001 From: Martin Kunz Date: Wed, 20 Aug 2025 22:29:17 +0200 Subject: [PATCH 3/4] fix(deps): Add source to the AbstractFFTs This should keep the source that is documented to be the HEAD version instead of the one in the registry. --- docs/Project.toml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/Project.toml b/docs/Project.toml index ba838d3e..078bad1a 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -2,5 +2,8 @@ AbstractFFTs = "621f4979-c628-5d54-868e-fcf4e3e8185c" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +[sources] +AbstractFFTs = { path = ".." } + [compat] Documenter = "^1" From 043294e01c638ced0cb83cc02142186405752c77 Mon Sep 17 00:00:00 2001 From: Martin Kunz Date: Wed, 20 Aug 2025 22:33:54 +0200 Subject: [PATCH 4/4] refactor(CI): Remove the unnecessary doc configuration --- .github/workflows/Documenter.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/Documenter.yml b/.github/workflows/Documenter.yml index 74d29f19..1ecbb7ce 100644 --- a/.github/workflows/Documenter.yml +++ b/.github/workflows/Documenter.yml @@ -31,7 +31,6 @@ jobs: shell: julia --project=docs --color=yes {0} run: | using Pkg - Pkg.develop(PackageSpec(path=pwd())) Pkg.instantiate() - uses: julia-actions/julia-buildpkg@v1 - run: julia --project=docs docs/make.jl