Skip to content

Update README

Update README #13

Workflow file for this run

name: Documentation
on:
push:
branches: ["master"]
paths:
- 'docs/**'
- '.github/workflows/deploy-pages.yml'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
jobs:
docs:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 2
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: 3.x
- name: Install MkDocs
run: |
pip install mkdocs-material
pip install mkdocs-git-revision-date-plugin
- name: Build documentation
run: |
cd docs
mkdocs build
cd ..
mv docs/site .
cp docs/.nojekyll site/
cp docs/CNAME site/CNAME
- name: Setup Pages
uses: actions/configure-pages@v4
with:
enablement: true
token: ${{ secrets.GITHUB_TOKEN }}
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: site