Skip to content

Commit

Permalink
CI: test doc in PR (#55)
Browse files Browse the repository at this point in the history
* rename workflow file to reflect documentation build and deployment; update Python version to 3.12

* add GitHub Actions workflow for building documentation with Sphinx

* rename
  • Loading branch information
mariogeiger authored Jan 7, 2025
1 parent d344ebc commit 31b3c48
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/doc_build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Build Documentation

on:
pull_request:
branches: [ "main" ]

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: "3.12"
- name: Build sphinx
run: |
python -m pip install --upgrade pip
python -m pip install pytest
python -m pip install ./cuequivariance
python -m pip install ./cuequivariance_jax
python -m pip install ./cuequivariance_torch
pip install -r docs/requirements.txt
sphinx-build -b html docs docs/public
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build Documentation
name: Build Documentation and Deploy

on:
# Runs on pushes targeting the default branch
Expand All @@ -21,8 +21,7 @@ concurrency:
cancel-in-progress: false

jobs:
# Single deploy job since we're just deploying
deploy:
build_deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
Expand All @@ -35,7 +34,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: "3.11"
python-version: "3.12"
- name: Build sphinx
run: |
python -m pip install --upgrade pip
Expand Down

0 comments on commit 31b3c48

Please # to comment.