Skip to content

update install.md guide #15

update install.md guide

update install.md guide #15

Workflow file for this run

name: Deploy Docs
on:
# Runs on pushes targeting the default branch
push:
branches: [docs]
# 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:
# Build job
build:
runs-on: ubuntu-latest
env:
POETRY_VERSION: 1.5.1
steps:
- name: Install Poetry
uses: snok/install-poetry@v1
- uses: actions/checkout@v3
- name: Install Instrukt Dependencies
run: |
poetry install --with=docs
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: Build sphinx doc
run: make docs-html
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./docs/build/html
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2