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 documentation workflow #9

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add documentation workflow #9

wants to merge 2 commits into from

Conversation

aversey
Copy link

@aversey aversey commented Feb 3, 2023

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.

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.

1 participant