Skip to content

document molecular dynamics #17

document molecular dynamics

document molecular dynamics #17

name: Deploy Sphinx Docs to GitHub Pages
on:
push:
branches: ["master"]
paths:
- 'docs/**'
- '.github/workflows/jekyll-gh-pages.yml'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install Python dependencies
run: |
pip install -U pip
pip install -r docs/requirements.txt
- name: Build Sphinx site
run: |
make -C docs html
cp -r docs/build/html _site
touch _site/.nojekyll # Prevent GitHub from ignoring _static/
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./_site
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4