From e6e36120725903bdcb176854876ad1648b983a35 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Sun, 13 Aug 2023 23:31:12 +0200 Subject: [PATCH] Implemented the Index HTML page generation into the "generate-docs" target in the Makefile file. --- Makefile | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index a8849ee..0dbd8db 100644 --- a/Makefile +++ b/Makefile @@ -70,31 +70,33 @@ endif # --- DOCUMENTAION --- # generate-docs: ## Generate DocC documentation for both Xcode and Web. + @make generate-index-start @make generate-doc-communication @make generate-doc-coordination @make generate-doc-dependency @make generate-doc-foundation @make generate-doc-persistence + @make generate-index-finish generate-doc-communication: SWIFT_TARGET_NAME=SwiftLibsCommunication generate-doc-communication: SWIFT_TARGET_COMPONENT=communication -generate-doc-communication: generate-doc-xcode generate-doc-github +generate-doc-communication: generate-doc-xcode generate-doc-github generate-index-link generate-doc-coordination: SWIFT_TARGET_NAME=SwiftLibsCoordination generate-doc-coordination: SWIFT_TARGET_COMPONENT=coordination -generate-doc-coordination: generate-doc-xcode generate-doc-github +generate-doc-coordination: generate-doc-xcode generate-doc-github generate-index-link generate-doc-dependency: SWIFT_TARGET_NAME=SwiftLibsDependency generate-doc-dependency: SWIFT_TARGET_COMPONENT=dependency -generate-doc-dependency: generate-doc-xcode generate-doc-github +generate-doc-dependency: generate-doc-xcode generate-doc-github generate-index-link generate-doc-foundation: SWIFT_TARGET_NAME=SwiftLibsFoundation generate-doc-foundation: SWIFT_TARGET_COMPONENT=foundation -generate-doc-foundation: generate-doc-xcode generate-doc-github +generate-doc-foundation: generate-doc-xcode generate-doc-github generate-index-link generate-doc-persistence: SWIFT_TARGET_NAME=SwiftLibsPersistence generate-doc-persistence: SWIFT_TARGET_COMPONENT=persistence -generate-doc-persistence: generate-doc-xcode generate-doc-github +generate-doc-persistence: generate-doc-xcode generate-doc-github generate-index-link generate-doc-xcode: @swift package \ @@ -115,6 +117,22 @@ generate-doc-github: --hosting-base-path ${DOCC_GITHUB_BASE_PATH} \ --output-path ${DOCC_GITHUB_OUTPUT} +generate-index-start: + @echo "" >> ${DOCC_GITHUB_INDEX} + @echo "" >> ${DOCC_GITHUB_INDEX} + @echo "${SWIFT_TARGET_NAME} libraries" >> ${DOCC_GITHUB_INDEX} + @echo "" >> ${DOCC_GITHUB_INDEX} + @echo "" >> ${DOCC_GITHUB_INDEX} + @echo "" >> ${DOCC_GITHUB_INDEX} + @echo "" >> ${DOCC_GITHUB_INDEX} + @echo "" >> ${DOCC_GITHUB_INDEX} + preview-doc: set-target ## Preview DocC documentation for a particular library. @open -a safari ${DOCC_PREVIEW_URL}${library} @swift package \