[Setup] DocC #13

Merged
javier merged 14 commits from setup/docc into main 2023-04-24 15:07:22 +00:00
Showing only changes of commit 931ebe32e0 - Show all commits

View File

@ -15,17 +15,7 @@ preview-doc: ## Previews the project documentation for web.
preview-documentation \
--target $(SWIFT_TARGET_NAME)
generate-doc: generate-doc-setup generate-doc-xcode generate-doc-github ## Generates the project documentation for Xcode and Github.
generate-doc-setup:
ifeq ("$(shell test -e ${SWIFT_DOC_GITHUB_OUTPUT} && echo yes)","yes")
@echo Cleaning up the Github pages folder...
@rm -rf ${SWIFT_DOC_GITHUB_OUTPUT}
endif
ifeq ("$(shell test -e ${SWIFT_DOC_XCODE_OUTPUT} && echo yes)","yes")
@echo Cleaning up the Xcode documentation archive...
@rm -rf ${SWIFT_DOC_XCODE_OUTPUT}
endif
generate-doc: generate-doc-xcode generate-doc-github ## Generates the project documentation for Xcode and Github.
generate-doc-xcode:
@echo Generating documentation for Xcode...
@ -45,6 +35,17 @@ generate-doc-github:
--transform-for-static-hosting \
--hosting-base-path $(SWIFT_DOC_GITHUB_BASE_PATH) \
--output-path $(SWIFT_DOC_GITHUB_OUTPUT)
clean-docs: ## Cleans up the generated documentation for Xcode and Github pages.
ifeq ("$(shell test -e ${SWIFT_DOC_GITHUB_OUTPUT} && echo yes)","yes")
@echo Cleaning up the Github pages folder...
@rm -rf ${SWIFT_DOC_GITHUB_OUTPUT}
endif
ifeq ("$(shell test -e ${SWIFT_DOC_XCODE_OUTPUT} && echo yes)","yes")
@echo Cleaning up the Xcode documentation archive...
@rm -rf ${SWIFT_DOC_XCODE_OUTPUT}
endif
# --- HELP ---