[Docs] Generate and Deploy DocC to GH pages #949
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On push to
main
branchdeploy_pages.yml
workflow is going to be run. Executing thegenerate_docs.sh
and then triggers deployment of github pages, deploying static site generated indocs
directorygenerate_docs.sh:
Runs
swift package generate-documentation
for each target defined inPackage.swift
. Currently there is no support for multiple targets so we are storing produces files in temporary folders and merging these folders in next steps, including generating rootindex.html
allowing to navigate to docs for individual targets as seen herehttps://walletconnect.github.io/WalletConnectSwiftV2/
Specific target documentation can be the found on following url
https://walletconnect.github.io/WalletConnectSwiftV2/documentation/${ TARGET_NAME.allLowerCased }
e.g.https://walletconnect.github.io/WalletConnectSwiftV2/documentation/walletconnectsign/