Reference

Configuration

Types and functions for configuring documentation generation.

Function	Description
FooterConfig	Configuration for page footer.
NavbarItem	Configuration for navbar items.
QuartoConfig	Main configuration struct for QuartoDocBuilder.
ReferenceGroup	Configuration for a reference section group.
SectionConfig	Configuration for a navbar section (supports multiple dropdowns).
ThemeConfig	Configuration for theming and appearance.
VersionConfig	Configuration for multi-version documentation.
default_config	default_config(module_name::Module) -> QuartoConfig
detect_repo	detect_repo() -> String
detect_version	detect_version() -> String
determine_version_segment	determine_version_segment(config::VersionConfig) -> String
get_current_branch	get_current_branch() -> String
get_current_tag	get_current_tag() -> String
get_dark_theme	get_dark_theme(light_theme::String) -> String
is_release_tag	is_release_tag() -> Bool
load_config	load_config(path::String=“_quartodoc.toml”) -> Union{QuartoConfig, Nothing}
merge_config	merge_config(base::QuartoConfig, overrides::QuartoConfig) -> QuartoConfig
validate_config	validate_config(config::QuartoConfig) -> Bool

Content Selectors

pkgdown-style helpers for organizing reference pages by matching function names.

Function	Description
apply_selector	apply_selector(selector, symbols::Vector{Symbol}) -> Vector{Symbol}
auto_group_objects	auto_group_objects(module_name::Module; recursive::Bool=false) -> Vector{Tuple{ReferenceGroup, Ve…
autodocs_group	autodocs_group(module_name::Module; title::String=“API Reference”, desc::String=““, filter=nothin…
check_missing_docstrings	check_missing_docstrings(module_name::Module; exported_only::Bool=true, warn::Bool=true) -> Vecto…
contains	contains(substring::String) -> Function
documentation_coverage	documentation_coverage(module_name::Module; exported_only::Bool=true) -> NamedTuple
ends_with	ends_with(suffix::String) -> Function
filter_objects	filter_objects(module_name::Module, selectors::Vector; recursive::Bool=false) -> Vector{Symbol}
group_objects	group_objects(module_name::Module, groups::Vector{ReferenceGroup}; recursive::Bool=false) -> Vect…
has_docstring	has_docstring(module_name::Module; recursive::Bool=false) -> Function
is_const_symbol	is_const_symbol(module_name::Module) -> Function
is_exported	is_exported(module_name::Module) -> Function
is_function_symbol	is_function_symbol(module_name::Module) -> Function
is_type_symbol	is_type_symbol(module_name::Module) -> Function
matches	matches(pattern::Union{String, Regex}) -> Function
parse_content_selector	parse_content_selector(s::String) -> Union{Symbol, Function}
reference_page_names	reference_page_names(bindings::Vector{Base.Docs.Binding}, root::Module) -> Dict{Base.Docs.Binding…
starts_with	starts_with(prefix::String) -> Function

Site Building

Core functions for generating documentation sites.

Function	Description
quarto_build_refpage	quarto_build_refpage(module_name; output = “docs/reference.qmd”, recursive = false)
quarto_build_refpage_grouped	quarto_build_refpage_grouped(module_name::Module, config::QuartoConfig; output::String=“docs/refe…
quarto_build_site	quarto_build_site(config::QuartoConfig)
quarto_rebuild_all	quarto_rebuild_all(config::QuartoConfig)
quarto_rebuild_reference	quarto_rebuild_reference(module_name::Module)
quarto_styles_from_config	quarto_styles_from_config(config::QuartoConfig)
quarto_yaml_from_config	quarto_yaml_from_config(config::QuartoConfig; force::Bool=false)

Docstring Processing

Functions for extracting and formatting Julia docstrings to Quarto format.

Function	Description
get_objects_from_module	get_objects_from_module(m::Module; recursive::Bool=false) -> Vector{Docs.Binding}
quarto_callout_block	quarto_callout_block(s)
quarto_doc	quarto_doc(b)
quarto_doc_page	quarto_doc_page(s; dir = “docs/reference”, name = nothing)
quarto_doc_short	quarto_doc_short(b; page_name = nothing)
quarto_format	quarto_format(m::Markdown.Code, eval = false)

Articles & News {#sec-articles-&-news}

Article discovery and changelog generation.

Function	Description
ArticleInfo	ArticleInfo
NewsVersion	NewsVersion
create_article_template	create_article_template(filepath::String; title::String=““, order::Int=999)
create_news_template	create_news_template(path::String=“NEWS.md”; package_name::String=“Package”)
detect_get_started	detect_get_started(module_name::Module; dir::String=“docs/articles”) -> Union{String, Nothing}
discover_articles	discover_articles(dir::String=“docs/articles”) -> Vector{String}
discover_articles_recursive	discover_articles_recursive(dir::String=“docs/articles”) -> Vector{String}
get_article_info	get_article_info(filepath::String) -> ArticleInfo
get_article_order	get_article_order(filepath::String) -> Int
get_article_title	get_article_title(filepath::String) -> String
has_news	has_news(config::QuartoConfig) -> Bool
linkify_github_refs	linkify_github_refs(text::String, repo::String) -> String
news_summary	news_summary(config::QuartoConfig) -> String
parse_news	parse_news(path::String=“NEWS.md”) -> Vector{NewsVersion}
quarto_news_page	quarto_news_page(config::QuartoConfig; output::String=“docs/news.qmd”)

Auto-linking

Automatic cross-reference linking in documentation.

Function	Description
ExternalDocsRegistry	ExternalDocsRegistry
ExternalRef	ExternalRef(package::String, symbol::String)
ReferenceIndex	ReferenceIndex
autolink_cross_package	autolink_cross_package(text::String, packages::Dict{String, ReferenceIndex}) -> String
autolink_external	autolink_external(text::String; registry=EXTERNAL_DOCS[]) -> String
autolink_references	autolink_references(text::String, index::ReferenceIndex) -> String
build_reference_index	build_reference_index(module_name::Module; base_path::String=“reference”, recursive::Bool=false) …
clear_external_docs	clear_external_docs(; registry=EXTERNAL_DOCS[])
create_reference_report	create_reference_report(module_name::Module) -> String
find_undefined_references	find_undefined_references(text::String, index::ReferenceIndex) -> Vector{String}
get_external_docs_url	get_external_docs_url(package::String; registry=EXTERNAL_DOCS[]) -> Union{String, Nothing}
link_julia_docs	link_julia_docs(text::String) -> String
list_external_docs	list_external_docs(; registry=EXTERNAL_DOCS[]) -> Dict{String, String}
parse_external_ref	parse_external_ref(ref::String) -> Union{ExternalRef, Nothing}
register_common_packages	register_common_packages(; load_inventories::Bool=false, registry=EXTERNAL_DOCS[])
register_external_docs	register_external_docs(package::String, base_url::String;
resolve_external_ref	resolve_external_ref(ref::ExternalRef; registry=EXTERNAL_DOCS[]) -> Union{String, Nothing}
resolve_reference	resolve_reference(name::String, index::ReferenceIndex) -> Union{String, Nothing}

Inventories

Sphinx objects.inv read/write for cross-package linking.

Function	Description
Inventory	Inventory
InventoryItem	InventoryItem
generate_inventory	generate_inventory(mod::Module; project=string(mod), version=““, base_url=”“, recursive=false) ->…
load_inventory	load_inventory(source::AbstractString; root_url=nothing) -> Inventory
resolve_inventory	resolve_inventory(inv::Inventory, name::AbstractString) -> Union{String, Nothing}
write_inventory	write_inventory(inv::Inventory, path::AbstractString) -> String

Link Checking & Versioning {#sec-link-checking-&-versioning}

Utilities for validating docs links and managing multi-version documentation.

Function	Description
LinkCheckReport	LinkCheckReport
LinkCheckResult	LinkCheckResult
check_internal_links	check_internal_links(docs_dir::String; verbose::Bool=true) -> LinkCheckReport
check_link	check_link(url::String; timeout::Int=10) -> Tuple{Symbol, String}
check_links	check_links(docs_dir::String; timeout::Int=10, ignore_patterns::Vector{String}=String[], verbose:…
extract_links	extract_links(text::String) -> Vector{String}
extract_links_from_file	extract_links_from_file(filepath::String) -> Vector{Tuple{String, Int}}
format_linkcheck_report	format_linkcheck_report(report::LinkCheckReport; include_ok::Bool=false) -> String
generate_versions_manifest	generate_versions_manifest(output_dir::String, current_version::String;
read_versions_manifest	read_versions_manifest(path::String) -> Vector{String}
write_version_selector_assets	write_version_selector_assets(docs_dir::String)

GitHub Integration

CI/CD workflow generation and deployment helpers.

Function	Description
quarto_docs_project_toml	quarto_docs_project_toml(module_name::Module)
quarto_github_action	quarto_github_action(; kwargs…)
quarto_github_action_simple	quarto_github_action_simple(; kwargs…)
quarto_github_action_versioned	quarto_github_action_versioned(; kwargs…)
quarto_makejl_template	quarto_makejl_template(module_name::Module; config_file::String=““, repo::String=”“)
quarto_setup_instructions	quarto_setup_instructions() -> String
setup_documentation	setup_documentation(module_name::Module; repo::String=““, kwargs…)