Skip to content

updated README to point to gh-pages #2

updated README to point to gh-pages

updated README to point to gh-pages #2

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Deploy YARD Documentation to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.2.2' # Match the Ruby version to your development environment
- name: Install dependencies
run: |
bundle config set --local path 'vendor/bundle'
bundle install --jobs 4 --retry 3
- name: Generate YARD Documentation
run: bundle exec yard doc
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload YARD documentation
uses: actions/upload-pages-artifact@v3
with:
path: './doc'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4