fix(docs): Update Documenter setup (#144)

* fix(docs): Update compat restriction for Documenter

* fix(docs): Move the comment before `Base.adjoint` before docstring

* 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.

* refactor(CI): Remove the unnecessary doc configuration

Author: kunzaatko

.github/workflows/Documenter.yml

@@ -42,7 +42,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 --color=yes docs/make.jl

docs/Project.toml

@@ -2,5 +2,8 @@
 AbstractFFTs = "621f4979-c628-5d54-868e-fcf4e3e8185c"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
+[sources]
+AbstractFFTs = { path = ".." }
+
 [compat]
-Documenter = "~0.25"
+Documenter = "^1"

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.