Skip to content

add readme with doc url #10

add readme with doc url

add readme with doc url #10

Workflow file for this run

name: Build documentation
on:
push:
branches:
- 'main'
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-and-deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Install Requirements
run: |
pip install -r ./requirements.txt
- name: Build docs
run: |
sphinx-build -b html . ./docs_build/
cd docs_build
touch .nojekyll
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: './docs_build'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4