adding documentation generation commands
This commit is contained in:
parent
1c6b8ab433
commit
ca8865b043
26
Makefile
26
Makefile
|
|
@ -68,4 +68,28 @@ preview-docs:
|
|||
# Preview DocC documentation with analysis/warnings and overview of coverage
|
||||
.PHONY: preview-analysis-docs
|
||||
preview-analysis-docs:
|
||||
swift package --disable-sandbox preview-documentation --target FirebladeECS --analyze --experimental-documentation-coverage --level brief
|
||||
swift package --disable-sandbox preview-documentation --target FirebladeECS --analyze --experimental-documentation-coverage --level brief
|
||||
|
||||
# Generates a plain DocC archive in the .build directory
|
||||
.PHONY: generate-docs
|
||||
generate-docs:
|
||||
DOCC_JSON_PRETTYPRINT=YES \
|
||||
swift package \
|
||||
generate-documentation \
|
||||
--fallback-bundle-identifier com.github.fireblade-engine.FirebladeECS \
|
||||
--target FirebladeECS \
|
||||
|
||||
# Generates documentation pages suitable to push/host on github pages (or another static site)
|
||||
# Expected location, if set up, would be:
|
||||
# https://fireblade-engine.github.io/FirebladeECS/documentation/FirebladeECS/
|
||||
.PHONY: generate-docs-githubpages
|
||||
generate-docs-githubpages:
|
||||
DOCC_JSON_PRETTYPRINT=YES \
|
||||
swift package \
|
||||
--allow-writing-to-directory ./docs \
|
||||
generate-documentation \
|
||||
--fallback-bundle-identifier com.github.fireblade-engine.FirebladeECS \
|
||||
--target FirebladeECS \
|
||||
--output-path ./docs \
|
||||
--transform-for-static-hosting \
|
||||
--hosting-base-path 'FirebladeECS'
|
||||
Loading…
Reference in New Issue