setup_documentation

docblock
setup_documentation(module_name::Module; repo::String="", kwargs...)

One-stop setup for documentation infrastructure.

Creates:

  • docs/make.jl
  • docs/Project.toml
  • .github/workflows/docs.yml
  • Initial documentation structure

Arguments

  • module_name::Module: The module to document
  • repo::String: GitHub repository in “user/repo” format
  • Additional kwargs passed to quarto_build_site

Example

setup_documentation(MyPackage; repo="myuser/MyPackage.jl")