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

Build and deploy swiftdoc using jazzy #293

Open
gburd opened this issue Aug 6, 2020 · 0 comments
Open

Build and deploy swiftdoc using jazzy #293

gburd opened this issue Aug 6, 2020 · 0 comments

Comments

@gburd
Copy link

gburd commented Aug 6, 2020

  • Move from using ghp-import to using a travis deploy stage to commit documentation updates.
  • Add Jazzy installation and swiftdoc generation to document building script.
  • Commit generated documentation to a new branch gh-pages-api-docs. The existing gh-pages branch was incorrectly formatted and it was easier to just create a new branch.
  • Remove existing cargo-doc script.
  • Ensure build phase only executes on the master branch.

TODO: Point GithubPages to gh-pages-api-docs branch rather than master. This is done directly in settings and so will not form part of this PR. It needs to be done once this patch has landed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant