Merge pull request #387 from control-toolbox/386-dev-update-documenterreference

Improve DocumenterReference

Author: ocots

Project.toml

@@ -1,6 +1,6 @@
 name = "CTBase"
 uuid = "54762871-cc72-4466-b8e8-f6c8b58076cd"
-version = "0.17.0"
+version = "0.17.1"
 authors = ["Olivier Cots <olivier.cots@irit.fr>", "Jean-Baptiste Caillau <caillau@univ-cotedazur.fr>"]
 
 [deps]

docs/make.jl

@@ -23,6 +23,18 @@ end
 # Repository configuration
 # ═══════════════════════════════════════════════════════════════════════════════
 repo_url = "github.com/control-toolbox/CTBase.jl"
+src_dir = abspath(joinpath(@__DIR__, "..", "src"))
+ext_dir = abspath(joinpath(@__DIR__, "..", "ext"))
+
+# Helper to build absolute paths
+src(files...) = [abspath(joinpath(src_dir, f)) for f in files]
+ext(files...) = [abspath(joinpath(ext_dir, f)) for f in files]
+
+# Symbols to exclude from documentation (auto-generated by @with_kw, etc.)
+const EXCLUDE_SYMBOLS = Symbol[
+    :include,
+    :eval,
+]
 
 # ═══════════════════════════════════════════════════════════════════════════════
 # Build documentation
@@ -46,59 +58,54 @@ makedocs(;
         "API Reference" => [
             CTBase.automatic_reference_documentation(;
                 subdirectory=".",
-                modules=[CTBase],
-                exclude=Symbol[:include, :eval],
+                primary_modules=[CTBase => src("CTBase.jl")],
+                exclude=EXCLUDE_SYMBOLS,
                 public=false,
                 private=true,
                 title="CTBase",
                 title_in_menu="CTBase",  # optionnel
                 filename="ctbase",
-                source_files=[abspath(joinpath(@__DIR__, "..", "src", "CTBase.jl"))],
             ),
             CTBase.automatic_reference_documentation(;
                 subdirectory=".",
-                modules=[CTBase],
-                exclude=Symbol[:include, :eval],
+                primary_modules=[CTBase => src("default.jl")],
+                exclude=EXCLUDE_SYMBOLS,
                 public=false,
                 private=true,
                 title="Default",
                 title_in_menu="Default",  # optionnel
                 filename="default",
-                source_files=[abspath(joinpath(@__DIR__, "..", "src", "default.jl"))],
             ),
             CTBase.automatic_reference_documentation(;
                 subdirectory=".",
-                modules=[CTBase],
-                exclude=Symbol[:include, :eval],
+                primary_modules=[CTBase => src("description.jl")],
+                exclude=EXCLUDE_SYMBOLS,
                 public=false,
                 private=true,
                 title="Description",
                 title_in_menu="Description",  # optionnel
                 filename="description",
-                source_files=[abspath(joinpath(@__DIR__, "..", "src", "description.jl"))],
             ),
             CTBase.automatic_reference_documentation(;
                 subdirectory=".",
-                modules=[CTBase],
-                doc_modules=[Base],  # pour inclure Base.showerror
-                exclude=Symbol[:include, :eval],
+                primary_modules=[CTBase => src("exception.jl")],
+                external_modules_to_document=[Base],  # pour inclure Base.showerror
+                exclude=EXCLUDE_SYMBOLS,
                 public=false,
                 private=true,
                 title="Exception",
                 title_in_menu="Exception",  # optionnel
                 filename="exception",
-                source_files=[abspath(joinpath(@__DIR__, "..", "src", "exception.jl"))],
             ),
             CTBase.automatic_reference_documentation(;
                 subdirectory=".",
-                modules=[CTBase],
-                exclude=Symbol[:include, :eval],
+                primary_modules=[CTBase => src("utils.jl")],
+                exclude=EXCLUDE_SYMBOLS,
                 public=false,
                 private=true,
                 title="Utils",
                 title_in_menu="Utils",  # optionnel
                 filename="utils",
-                source_files=[abspath(joinpath(@__DIR__, "..", "src", "utils.jl"))],
             ),
         ],
     ],