Skip to content
Build and Deploy Sphinx Docs for ALF

delete myst parser #5

Sign in to view logs

delete myst parser

delete myst parser #5

Workflow file for this run

.github/workflows/sphinx-docs.yml at f1cb14b
name: Build and Deploy Sphinx Docs for ALF
on:
push:
branches:
- docs # TODO: Should be changed to main when ALF finalized
pull_request:
branches:
- docs # TODO: Should be changed to main when ALF finalized
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.12'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx_rtd_theme sphinx_autodoc_typehints
- name: Build Docs
run: |
sphinx-build -b html docs/source docs/_autobuild/html
- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/main' # Only deploy on main branch
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_autobuild/html