Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Generate and Deploy DocC to GH pages #949

Merged
merged 2 commits into from
Jul 13, 2023
Merged

[Docs] Generate and Deploy DocC to GH pages #949

merged 2 commits into from
Jul 13, 2023

Conversation

radeknovis
Copy link
Contributor

@radeknovis radeknovis commented Jul 7, 2023

On push to main branch deploy_pages.yml workflow is going to be run. Executing the generate_docs.sh and then triggers deployment of github pages, deploying static site generated in docs directory

generate_docs.sh:

Runs swift package generate-documentation for each target defined in Package.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 root index.html allowing to navigate to docs for individual targets as seen here
https://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/

@radeknovis radeknovis temporarily deployed to internal July 7, 2023 13:10 — with GitHub Actions Inactive
@radeknovis radeknovis temporarily deployed to github-pages July 7, 2023 13:10 — with GitHub Pages Inactive
@radeknovis radeknovis temporarily deployed to internal July 7, 2023 14:00 — with GitHub Actions Inactive
@radeknovis radeknovis temporarily deployed to internal July 7, 2023 14:03 — with GitHub Actions Inactive
@radeknovis radeknovis temporarily deployed to internal July 7, 2023 14:09 — with GitHub Actions Inactive
@radeknovis radeknovis changed the title [Docs] [Docs] Generate and Deploy DocC to GH pages Jul 7, 2023
@radeknovis radeknovis marked this pull request as ready for review July 7, 2023 14:17
@radeknovis radeknovis temporarily deployed to internal July 7, 2023 14:54 — with GitHub Actions Inactive
@radeknovis radeknovis temporarily deployed to internal July 7, 2023 14:58 — with GitHub Actions Inactive
@radeknovis radeknovis temporarily deployed to internal July 10, 2023 08:52 — with GitHub Actions Inactive
@radeknovis radeknovis temporarily deployed to internal July 13, 2023 11:01 — with GitHub Actions Inactive
@radeknovis radeknovis merged commit c85c912 into develop Jul 13, 2023
8 checks passed
@radeknovis radeknovis deleted the docs branch July 13, 2023 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants