Skip to content

Update INSTALL.md

Update INSTALL.md #27

name: Build and Publish Sphinx Documentation
on:
push:
branches: ["master"]
# Allows you to run this workflow manually from the Actions tab
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-and-publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4 # Checks-out your repository under $GITHUB_WORKSPACE
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11' # Set up the Python version you need
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install sphinx myst-parser sphinx-rtd-theme # Add other dependencies you might have
- name: Build Sphinx Documentation
run: |
cd docs # Change to your documentation directory if needed
make html
cd ..
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: './docs/build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4