Skip to content

📃 Publish documentation #48

📃 Publish documentation

📃 Publish documentation #48

Workflow file for this run

name: Publish documentation
on:
push:
branches: [ master ]
paths:
- musify/**
- docs/**
- make*
pull_request_target:
branches: [ master ]
paths:
- musify/**
- docs/**
- make*
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:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '>=3.12'
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install dependencies
run: |
sudo apt install graphviz
- name: Install module
run: |
pip install -e '.[docs]'
- name: Sphinx build
run: |
make clean
sphinx-apidoc -o ./docs ./musify -d 4 --force --module-first --separate --no-toc -t ./docs/_templates
make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/_build/html
deploy:
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/master'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4