Files
swift-cli-doc/justfile
Michael Housh 78a632c3e5
All checks were successful
CI / Run tests. (push) Successful in 52s
feat: Adds more documentation and examples.
2024-12-08 18:27:31 -05:00

42 lines
1.0 KiB
Makefile

docker_image_name := "clidoc"
[private]
default:
@just --list
clean:
@rm -rf .build
snapshot command outputDir="./Sources/CliDocCore/Documentation.docc/Resources":
@just -f Examples/justfile snapshot {{command}} ".{{outputDir}}"
test-docker: build-docker
@docker run -t --rm {{docker_image_name}}:test swift test
build-docker:
@docker build \
--file docker/Dockerfile.test \
--tag {{docker_image_name}}:test \
.
preview-documentation target="CliDoc":
# using the --enable-experimental-combined-documentation doesn't work in previews currently.
@swift package \
--disable-sandbox \
--allow-writing-to-directory "docs/" \
preview-documentation \
--target {{target}} \
--include-extended-types \
--enable-inherited-docs \
build-documentation:
swift package \
--disable-sandbox \
--allow-writing-to-directory "docs/" \
generate-documentation \
--target CliDoc \
--target CliDocCore \
--output-path "docs/" \
--transform-for-static-hosting \
--enable-experimental-combined-documentation