Skip to content

fix: multi-function name error #44

fix: multi-function name error

fix: multi-function name error #44

Workflow file for this run

name: docs_pages_workflow
# execute this workflow automatically when a we push to master
on:
push:
branches: [ dev ]
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
# https://github.com/ad-m/github-push-action/issues/52
permissions: write-all
jobs:
build_docs_job:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- name: Checkout 🛎️
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install OptiPNG and Build 🔧
run: |
sudo apt-get install -y optipng
- name: Install dependencies 💻
run: |
pip install -r docs/requirements.txt
- name: make the sphinx docs
run: |
make -C docs clean
make -C docs html
- name: Init new repo in dist folder and commit generated files
run: |
cd docs/build/html/
git init
touch .nojekyll
git add -A
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git commit -m 'deploy'
- name: Force push to destination branch 🚀
uses: ad-m/github-push-action@v0.8.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
force: true
directory: ./docs/build/html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/build/html
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build_docs_job
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4