julia-docs/SKILL.md
Build Julia package documentation with Documenter.jl, including docstrings, doctests, and citations. Use when setting up docs/, configuring make.jl, or writing documentation content.
npx skillsauth add krastanov/juliallmagentskills julia-docsInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Use this skill for the full documentation workflow: docs site setup, docstrings, doctests, and citations.
using Pkg
Pkg.activate("docs")
Pkg.add("Documenter")
Pkg.develop(path=pwd())
using Documenter
using MyPackage
DocMeta.setdocmeta!(MyPackage, :DocTestSetup, :(using MyPackage); recursive=true)
makedocs(
sitename = "MyPackage.jl",
modules = [MyPackage],
pages = ["Home" => "index.md", "API" => "api.md"],
)
julia -tauto --project=docs docs/make.jl
docs/make.jlRun doctests via julia-tests; use this skill for how to write and configure
them.
references/page-templates.mdreferences/docstring-templates.mdreferences/doctests.mdreferences/makedocs-options.mdreferences/at-blocks.mdreferences/citations-examples.mddocs/Project.toml exists and includes doc dependenciesdocs/make.jl loads all relevant modules and extensionsDocMeta.setdocmeta! is configured for doctestsfilter = ... syntax when the scope should be a single blocksetup = ... or module-level DocMeta, not ad hoc assumptionsJULIA_DEBUG=Documenter is used when filter behavior is uncleardevelopment
Fix trailing whitespace and ensure files end with newlines. Use this skill when preparing code for commit or when whitespace issues are detected.
development
Parse and write YAML in Julia with YAML.jl, including load/load_file/load_all APIs, dictionary type customization, anchors/aliases behavior, and write/write_file emission. Use this skill when reading YAML configs, converting YAML to Julia structures, or generating YAML outputs from Julia data.
development
Parse and write TOML in Julia using the TOML standard library (TOML.jl), including parse/tryparse APIs, ParserError handling, Parser reuse, and TOML.print serialization options. Use this skill when reading or generating TOML config files such as Project.toml, Manifest snippets, or other TOML-based settings.
development
Implement and debug Julia multithreading with Threads.@threads, Threads.@spawn, threadpools, locks, atomics, and race-avoidance patterns. Use this skill when parallelizing CPU work, configuring Julia thread counts, fixing data races, or handling thread-specific caveats such as task migration.