Skip to content

Document the option to run LOBSTER with one jobscript only (#811) #293

Document the option to run LOBSTER with one jobscript only (#811)

Document the option to run LOBSTER with one jobscript only (#811) #293

Workflow file for this run

name: build-docs
on:
workflow_dispatch:
push:
branches: [main]
# set GITHUB_TOKEN permissions to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
jobs:
build-docs:
if: github.repository_owner == 'materialsproject' && github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.workflow_run.head_branch }}
- name: Install pandoc
run: sudo apt-get install pandoc
- uses: actions/setup-python@v5
with:
python-version: "3.10"
cache: pip
cache-dependency-path: pyproject.toml
- name: Install dependencies
run: |
python -m pip install --upgrade pip
# ase needed to get FrechetCellFilter used by ML force fields
pip install git+https://gitlab.com/ase/ase
pip install .[strict,docs]
- name: Build
run: sphinx-build docs docs_build
- name: Upload build artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./docs_build
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build-docs
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2