Javier Cicchelli
a51fab18ba
This PR contains the work done to address the issue #11, related to setting up DocC documentation in this project. To provide further details about the work done: - [x] created the documentation catalog for the project in Xcode; - [x] added the `Swift-DocC-Plugin` dependency to the `Package` file; - [x] implemented documentation preview, generation and cleanup workflows in the `Makefile` file; - [x] generated documentation for Xcode and Github pages; - [x] added the package logo assets to the project; - [x] integrated the package logo assets to the `README` file, with support for both light and dark color schemes; - [x] added the `.env` file to the `.gitignore` file. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: #13
59 lines
1.9 KiB
Makefile
59 lines
1.9 KiB
Makefile
# --- IMPORTS ---
|
|
|
|
# Imports environment variables.
|
|
environment_vars ?= .env
|
|
|
|
include $(environment_vars)
|
|
export $(shell sed 's/=.*//' $(environment_vars))
|
|
|
|
# --- DOCUMENTATION ---
|
|
|
|
preview-doc: ## Previews the project documentation for web.
|
|
@open -a safari $(SWIFT_DOC_PREVIEW_URL)
|
|
@swift package \
|
|
--disable-sandbox \
|
|
preview-documentation \
|
|
--target $(SWIFT_TARGET_NAME)
|
|
|
|
generate-docs: generate-doc-xcode generate-doc-github ## Generates the project documentation for Xcode and Github.
|
|
|
|
generate-doc-xcode:
|
|
@echo Generating documentation for Xcode...
|
|
@swift package \
|
|
--allow-writing-to-directory $(SWIFT_DOC_XCODE_OUTPUT) \
|
|
generate-documentation \
|
|
--target $(SWIFT_TARGET_NAME) \
|
|
--output-path $(SWIFT_DOC_XCODE_OUTPUT)
|
|
|
|
generate-doc-github:
|
|
@echo Generating documentation for Github pages...
|
|
@swift package \
|
|
--allow-writing-to-directory $(SWIFT_DOC_GITHUB_OUTPUT) \
|
|
generate-documentation \
|
|
--target $(SWIFT_TARGET_NAME) \
|
|
--disable-indexing \
|
|
--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 ---
|
|
|
|
# Outputs the documentation for each of the defined tasks when `help` is called.
|
|
# Reference: https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
|
|
.PHONY: help
|
|
|
|
help: ## Prints the written documentation for all the defined tasks.
|
|
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
|
|
|
|
.DEFAULT_GOAL := help
|