Skip to content

Commit

Permalink
Configure docs deployment action
Browse files Browse the repository at this point in the history
  • Loading branch information
amorehead committed May 23, 2024
1 parent 925487c commit ea42bd5
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
27 changes: 27 additions & 0 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: documentation

on: [push, pull_request, workflow_dispatch]

permissions:
contents: write

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install -r docs/.docs.requirements
- name: Sphinx build
run: |
rm -rf docs/build/ && sphinx-build docs/source/ docs/build/
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/
force_orphan: true
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

Comprehensive benchmarking of protein-ligand structure generation methods

[Documentation](https://posebench.github.io/)
[Documentation](https://bioinfomachinelearning.github.io/PoseBench/)

## Contents

Expand Down

0 comments on commit ea42bd5

Please sign in to comment.