Skip to content

Commit

Permalink
DOC: add documentation job
Browse files Browse the repository at this point in the history
  • Loading branch information
ColmTalbot authored Feb 23, 2024
1 parent 7ba2fe1 commit c3c6f8d
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: GitHub Pages

on:
push:
branches:
- github-main
pull_request:
branches:
- github-main

jobs:
deploy:
runs-on: ubuntu-latest
container: containers.ligo.org/lscsoft/bilby/v2-bilby-python310
steps:
- uses: actions/checkout@v3
- name: install
run: python -m pip install .
- name: Run jupyter notebooks
run: |
python -m ipykernel install
cd examples/tutorials
jupyter nbconvert --to notebook --execute *.ipynb --output-dir ../../docs
cd -
- name: Build docs
run: |
cd docs
make clean
make html
# Disable docs deployment until we move primarily to GitHub
# - name: Deploy
# uses: peaceiris/actions-gh-pages@v3
# if: ${{ github.ref == 'refs/heads/master' }}
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: .

0 comments on commit c3c6f8d

Please sign in to comment.