Update API reference and fix documentation cross-references

- docs/api_reference.jl: Add all missing source files to each module's documentation (Core, Unicode, Extensions, and all extensions)
- docs/src/guide/test-runner.md: Remove invalid @ref to TestRunner.TestRunInfo (not accessible in documentation context)
- ext/TestRunner/entry_point.jl: Remove invalid @ref to TestRunner.TestRunInfo from docstring
- src/Core: Rename utils.jl to default.jl for clarity

Author: ocots

docs/api_reference.jl

@@ -17,7 +17,13 @@ function generate_api_reference(src_dir::String)
     pages = [
         CTBase.automatic_reference_documentation(;
             subdirectory="api",
-            primary_modules=[CTBase.Core => src(joinpath("Core", "Core.jl"))],
+            primary_modules=[
+                CTBase.Core => src(
+                    joinpath("Core", "Core.jl"),
+                    joinpath("Core", "default.jl"),
+                    joinpath("Core", "types.jl"),
+                ),
+            ],
             exclude=EXCLUDE_SYMBOLS,
             public=true,
             private=true,
@@ -63,7 +69,13 @@ function generate_api_reference(src_dir::String)
         ),
         CTBase.automatic_reference_documentation(;
             subdirectory="api",
-            primary_modules=[CTBase.Unicode => src(joinpath("Unicode", "Unicode.jl"))],
+            primary_modules=[
+                CTBase.Unicode => src(
+                    joinpath("Unicode", "Unicode.jl"),
+                    joinpath("Unicode", "subscripts.jl"),
+                    joinpath("Unicode", "superscripts.jl"),
+                ),
+            ],
             exclude=EXCLUDE_SYMBOLS,
             public=true,
             private=false, # there is no private API
@@ -74,7 +86,12 @@ function generate_api_reference(src_dir::String)
         CTBase.automatic_reference_documentation(;
             subdirectory="api",
             primary_modules=[
-                CTBase.Extensions => src(joinpath("Extensions", "Extensions.jl"))
+                CTBase.Extensions => src(
+                    joinpath("Extensions", "Extensions.jl"),
+                    joinpath("Extensions", "coverage_postprocessing.jl"),
+                    joinpath("Extensions", "documenter_reference.jl"),
+                    joinpath("Extensions", "test_runner.jl"),
+                ),
             ],
             exclude=EXCLUDE_SYMBOLS,
             public=true,
@@ -102,7 +119,19 @@ function generate_api_reference(src_dir::String)
             pages,
             CTBase.automatic_reference_documentation(;
                 subdirectory="api",
-                primary_modules=[DocumenterReference => ext("DocumenterReference.jl")],
+                primary_modules=[
+                    DocumenterReference => ext(
+                        joinpath("DocumenterReference", "DocumenterReference.jl"),
+                        joinpath("DocumenterReference", "config_helpers.jl"),
+                        joinpath("DocumenterReference", "entry_point.jl"),
+                        joinpath("DocumenterReference", "page_building.jl"),
+                        joinpath("DocumenterReference", "source_file_detection.jl"),
+                        joinpath("DocumenterReference", "symbol_classification.jl"),
+                        joinpath("DocumenterReference", "symbol_iteration.jl"),
+                        joinpath("DocumenterReference", "type_formatting.jl"),
+                        joinpath("DocumenterReference", "types.jl"),
+                    ),
+                ],
                 external_modules_to_document=[CTBase],
                 exclude=EXCLUDE_DOCREF,
                 public=false, # there is no public API
@@ -121,7 +150,11 @@ function generate_api_reference(src_dir::String)
             CTBase.automatic_reference_documentation(;
                 subdirectory="api",
                 primary_modules=[
-                    CoveragePostprocessing => ext("CoveragePostprocessing.jl")
+                    CoveragePostprocessing => ext(
+                        joinpath("CoveragePostprocessing", "CoveragePostprocessing.jl"),
+                        joinpath("CoveragePostprocessing", "entry_point.jl"),
+                        joinpath("CoveragePostprocessing", "helpers.jl"),
+                    ),
                 ],
                 external_modules_to_document=[CTBase],
                 exclude=EXCLUDE_SYMBOLS,
@@ -140,7 +173,17 @@ function generate_api_reference(src_dir::String)
             pages,
             CTBase.automatic_reference_documentation(;
                 subdirectory="api",
-                primary_modules=[TestRunner => ext("TestRunner.jl")],
+                primary_modules=[
+                    TestRunner => ext(
+                        joinpath("TestRunner", "TestRunner.jl"),
+                        joinpath("TestRunner", "arg_parsing.jl"),
+                        joinpath("TestRunner", "entry_point.jl"),
+                        joinpath("TestRunner", "progress.jl"),
+                        joinpath("TestRunner", "test_execution.jl"),
+                        joinpath("TestRunner", "test_selection.jl"),
+                        joinpath("TestRunner", "types.jl"),
+                    ),
+                ],
                 external_modules_to_document=[CTBase],
                 exclude=EXCLUDE_SYMBOLS,
                 public=false, # there is no public API

docs/src/guide/test-runner.md

@@ -227,20 +227,20 @@ The progress line is also automatically disabled when a custom `on_test_done` ca
 
 ## Callbacks
 
-The `on_test_start` and `on_test_done` callbacks allow custom actions during the test lifecycle. Both receive a [`TestRunner.TestRunInfo`](@ref) struct.
+The `on_test_start` and `on_test_done` callbacks allow custom actions during the test lifecycle. Both receive a `TestRunInfo` struct with the following fields:
 
 ### `TestRunInfo`
 
 ```julia
 struct TestRunInfo
-    spec::Union{Symbol,String}          # Test identifier
+    spec::Union{Symbol,String}           # Test identifier
     filename::String                     # Absolute path of the test file
-    func_symbol::Union{Symbol,Nothing}  # Function to call (nothing if eval_mode=false)
+    func_symbol::Union{Symbol,Nothing}   # Function to call (nothing if eval_mode=false)
     index::Int                           # 1-based index in the selected list
     total::Int                           # Total number of selected tests
     status::Symbol                       # See below
-    error::Union{Exception,Nothing}     # Captured exception (only when status == :error)
-    elapsed::Union{Float64,Nothing}     # Wall-clock seconds (only in on_test_done)
+    error::Union{Exception,Nothing}      # Captured exception (only when status == :error)
+    elapsed::Union{Float64,Nothing}      # Wall-clock seconds (only in on_test_done)
 end
 ```
 

ext/TestRunner/entry_point.jl

@@ -45,7 +45,7 @@ julia> CTBase.Extensions.run_tests(;
        )
 ```
 
-See also: [`CTBase.Extensions.run_tests`](@ref), [`CTBase.TestRunner.TestRunInfo`](@ref)
+See also: [`CTBase.Extensions.run_tests`](@ref)
 """
 function Extensions.run_tests(
     ::CTBase.Extensions.TestRunnerTag;

src/Core/Core.jl

@@ -11,7 +11,7 @@ module Core
 import DocStringExtensions: TYPEDEF, TYPEDSIGNATURES
 
 include("types.jl")
-include("utils.jl")
+include("default.jl")
 
 # Export public API
 export ctNumber