Use SciMLTesting 2.1 QA docs check (#163)

* Use SciMLTesting 2.1 QA docs check

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>

* Drop redundant QA self source

SciMLTesting develops the package under test before running the QA group, so the QA project does not need a self `[sources]` path entry. Removing it avoids leaking local checkout paths into the PR.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>

---------

Co-authored-by: ChrisRackauckas-Claude <accounts@chrisrackauckas.com>

Author: ChrisRackauckas-Claude

docs/src/functions.md

@@ -2,5 +2,10 @@
 ```
 
 ```@docs
+POD
+reduce!
+SVD
+TSVD
+RSVD
 deim
 ```

src/DataReduction/POD.jl

@@ -26,6 +26,12 @@ end
 
 _rsvd(data, n::Int, p::Int) = rsvd(data, n, p)
 
+"""
+    POD(snapshots; min_renergy = 1.0, min_nmodes = 1, max_nmodes = length(snapshots[1]))
+    POD(snapshots, nmodes)
+
+Proper orthogonal decomposition reduction problem built from state snapshots.
+"""
 mutable struct POD{S, T <: AbstractFloat} <: AbstractDRProblem
     # specified
     snapshots::S
@@ -81,6 +87,11 @@ function determine_truncation(
     return nmodes, energy
 end
 
+"""
+    reduce!(pod, alg)
+
+Compute the reduced basis and spectrum for `pod` using the SVD backend `alg`.
+"""
 function reduce!(pod::POD{S, T}, alg::SVD)::Nothing where {S, T}
     u, s, v = _svd(pod.snapshots; alg.kwargs...)
     pod.nmodes,

src/Types.jl

@@ -4,6 +4,11 @@ abstract type AbstractDRProblem <: AbstractReductionProblem end
 
 abstract type AbstractSVD end
 
+"""
+    SVD(; kwargs...)
+
+Dense singular value decomposition backend for projection basis construction.
+"""
 struct SVD{K <: NamedTuple} <: AbstractSVD
     kwargs::K
     function SVD(; kwargs...)
@@ -12,6 +17,11 @@ struct SVD{K <: NamedTuple} <: AbstractSVD
     end
 end
 
+"""
+    TSVD(; kwargs...)
+
+Truncated singular value decomposition backend for projection basis construction.
+"""
 struct TSVD{K <: NamedTuple} <: AbstractSVD
     kwargs::K
     function TSVD(; kwargs...)
@@ -20,6 +30,11 @@ struct TSVD{K <: NamedTuple} <: AbstractSVD
     end
 end
 
+"""
+    RSVD([p])
+
+Randomized singular value decomposition backend with oversampling parameter `p`.
+"""
 struct RSVD <: AbstractSVD
     p::Int
     function RSVD(p::Int = 0)

test/Project.toml

@@ -13,4 +13,4 @@ MethodOfLines = "0.11"
 ModelingToolkit = "11"
 OrdinaryDiffEq = "7"
 SafeTestsets = "0.1"
-SciMLTesting = "1"
+SciMLTesting = "2.1"

test/qa/Project.toml

@@ -12,8 +12,5 @@ Aqua = "0.8"
 JET = "0.9, 0.10, 0.11"
 LinearAlgebra = "1"
 SafeTestsets = "0.0.1, 0.1"
-SciMLTesting = "1.7"
+SciMLTesting = "2.1"
 Test = "1"
-
-[sources]
-ModelOrderReduction = {path = "../.."}

test/qa/qa.jl

@@ -3,6 +3,7 @@ using SciMLTesting, ModelOrderReduction, Test
 run_qa(
     ModelOrderReduction;
     explicit_imports = true,
+    api_docs_kwargs = (; rendered = true),
     # Whole-package JET (`report_package`/`test_package`) hits a toplevel
     # `invalid redefinition of constant ModelOrderReduction.TSVD` error: the package
     # exports a `TSVD` struct whose name collides with the `TSVD` dependency package