From 2c5b76d425952400ca347408b9fe0640d82ff4f2 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Tue, 9 Sep 2025 11:52:16 +0200 Subject: [PATCH] Added the documentation tasks to the Makefile file in the project. --- Makefile | 44 ++++++++++++++++++++++++++++++++++++-------- 1 file changed, 36 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index 04010b0..c7ce1c7 100644 --- a/Makefile +++ b/Makefile @@ -17,14 +17,6 @@ environment ?= .env include $(environment) export $(shell sed 's/=.*//' $(environment)) -# IDE - -open-in-xcode: ## Opens this package with Xcode - @open -a Xcode Package.swift - -open-in-vscode: ## Opens this package with Visual Studio Code - @code . - # SWIFT PACKAGE MANAGER package-build: ## Builds the project locally @@ -41,6 +33,42 @@ package-reset: ## Resets the complete SPM cache/build folder from the package package-update: ## Updates the SPM package dependencies @swift package update + +# DOCUMENTATION + +doc-generate: doc-generate-xcode doc-generate-github ## Generates the library documentation for both Github and Xcode + +doc-generate-github: ## Generates the library documentation for Github + @swift package \ + --allow-writing-to-directory $(DOCC_GITHUB_OUTPUT) \ + generate-documentation \ + --target $(SPM_LIBRARY_TARGET) \ + --disable-indexing \ + --transform-for-static-hosting \ + --hosting-base-path $(DOCC_GITHUB_BASE_PATH) \ + --output-path $(DOCC_GITHUB_OUTPUT) + +doc-generate-xcode: ## Generates the library documentation for Xcode + @swift package \ + --allow-writing-to-directory $(DOCC_XCODE_OUTPUT) \ + generate-documentation \ + --target $(SPM_LIBRARY_TARGET) \ + --output-path $(DOCC_XCODE_OUTPUT) + +doc-preview: ## Previews the library documentation in Safari + @open -a safari $(DOCC_PREVIEW_URL) + @swift package \ + --disable-sandbox \ + preview-documentation \ + --target $(SPM_LIBRARY_TARGET) + +# IDE + +open-in-xcode: ## Opens this package with Xcode + @open -a Xcode Package.swift + +open-in-vscode: ## Opens this package with Visual Studio Code + @code . # HELP