Skip to content
Build Documentation

Update docs folder and add github action for building documentation. #1

Sign in to view logs

Update docs folder and add github action for building documentation.

Update docs folder and add github action for building documentation. #1

Workflow file for this run

.github/workflows/build-docs.yml at 753c850
name: Build Documentation
on:
push:
tags:
- v*.*.*
env:
GH_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
jobs:
docs:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Check out Git repository
uses: actions/checkout@v3
- name: Install Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Install Dependencies
working-directory: ./documentation
run: pip install -r requirements.txt
- name: Build Documentation
working-directory: ./documentation
run: mkdocs build
- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: documentation/site