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

Add DocC publish workflow to automate GitHub pages content #2

Open
kublaios opened this issue Mar 13, 2024 · 0 comments
Open

Add DocC publish workflow to automate GitHub pages content #2

kublaios opened this issue Mar 13, 2024 · 0 comments
Labels
automation documentation Improvements or additions to documentation

Comments

@kublaios
Copy link
Contributor

Currently, we have to run the following command locally and commit the generated docs directory under gh-pages branch:

swift package --allow-writing-to-directory docs \
    generate-documentation \
    --target CutwormBDD \
    --disable-indexing \
    --transform-for-static-hosting \
    --output-path docs

P.S. For this to work, https://github.com/apple/swift-docc-plugin needs to be in package dependencies.

We can automate this step as described here: https://danielsaidi.com/blog/2024/03/10/automating-docc-for-a-swift-package-with-github-actions

@kublaios kublaios added documentation Improvements or additions to documentation automation labels Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant