Add documentation workflow #9
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds GitHub Actions workflow docs.yml which builds API documentation and deploys it to GitHub Pages. To make it able to work, you will need to change settings: on GitHub page Settings->Pages of the repository change Source to GitHub Actions. The documentation will be available at phaller.github.io/spores3. It is possible to set up different domain name for the docs site, for example api.spores3.phaller.com: the domain name should point to GitHub and Custom domain on page Settings->Pages needs to be set to api.spores3.phaller.com.
In order to remove dependency on the used Scala version, build.sbt is also changed: target directory for docs is set up to be target/api instead of target/scala-{version}/api.