Skip to content

Updates to SMARTS toolkit #18

Updates to SMARTS toolkit

Updates to SMARTS toolkit #18

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch:
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Cache pip dependencies
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-docs-${{ hashFiles('**/pyproject.toml') }}
restore-keys: |
${{ runner.os }}-pip-docs-
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx
pip install -e .
- name: Build documentation
run: |
cd docs
make clean
make html
- name: Check for .nojekyll file
run: |
if [ -f docs/build/html/.nojekyll ]; then
echo "✅ .nojekyll file created successfully"
else
echo "⚠️ .nojekyll file not found"
exit 1
fi
- name: Deploy to GitHub Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html
force_orphan: true
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
commit_message: 'Deploy documentation from ${{ github.sha }}'