rock-n-code/swift-libs
rock-n-code/swift-libs
1
0
Fork 0
Code Issues 1 Pull Requests Releases 13 Wiki Activity

[Enhancement] DocC documentation support #23

Merged
javier merged 14 commits from enhancement/documentation into main 2023-08-13 22:01:02 +00:00
Conversation 0 Commits 14 Files Changed 1401 +23 -5
1 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit e6e3612072 - Show all commits

28
Makefile
View File

@ -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 "<html>" >> ${DOCC_GITHUB_INDEX}
@echo "<head>" >> ${DOCC_GITHUB_INDEX}
@echo "<title>${SWIFT_TARGET_NAME} libraries</title>" >> ${DOCC_GITHUB_INDEX}
@echo "</head>" >> ${DOCC_GITHUB_INDEX}
@echo "<body>" >> ${DOCC_GITHUB_INDEX}
@echo "<ul>" >> ${DOCC_GITHUB_INDEX}
generate-index-link:
@echo "<li><a href=\"${DOCC_GITHUB_BASE_URL}${SWIFT_TARGET_COMPONENT}\" target=\"_self\">${SWIFT_TARGET_NAME} library</a></li>" >> ${DOCC_GITHUB_INDEX}
generate-index-finish:
@echo "</ul>" >> ${DOCC_GITHUB_INDEX}
@echo "</body>" >> ${DOCC_GITHUB_INDEX}
@echo "</html>" >> ${DOCC_GITHUB_INDEX}
preview-doc: set-target ## Preview DocC documentation for a particular library.
@open -a safari ${DOCC_PREVIEW_URL}${library}
@swift package \