Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

Updated README

Updated README #4

Workflow file for this run

name: Build and Deploy Docs
on:
push:
branches: ["master"]
jobs:
build-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.12'
- name: Install dependencies
run: pip install -r requirements.docs.txt && pip install -r requirements.txt
- name: Build
# Create .nojekyll file to disable Jekyll processing
run: |
cd docs
make html
touch build/html/.nojekyll
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html