autodocs_group

Notedocblock 
autodocs_group(module_name::Module; title::String="API Reference", desc::String="", filter=nothing, recursive::Bool=false) -> ReferenceGroup

Create a ReferenceGroup that automatically includes all documented symbols from a module. Similar to Documenter.jl’s @autodocs macro.

Arguments

  • module_name::Module: Module to document
  • title::String: Group title (default: “API Reference”)
  • desc::String: Group description
  • filter: Optional filter function (e.g., is_exported(MyModule))
  • recursive::Bool: When true, include documented symbols from submodules (default: false).

Example

# Include all documented symbols
group = autodocs_group(MyModule)

# Include only exported, documented symbols
group = autodocs_group(MyModule;
    title="Public API",
    filter=is_exported(MyModule)
)

# Include submodule symbols as well
group = autodocs_group(MyModule; recursive=true)

# Use in config
config = QuartoConfig(
    module_name = MyModule,
    reference = [autodocs_group(MyModule)]
)