Skip to content

adding workflows for docs build #1

adding workflows for docs build

adding workflows for docs build #1

name: Deploy Sphinx Documentation to GitHub Pages
on:
push:
branches:
- sg_docs # Change this to your default branch
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.11' # Specify the Python version you want
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-rtd-theme
- name: Build Sphinx documentation
run: |
cd docs # Change this to your docs directory if it's not 'docs'
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html # Change this if your output directory is different