From ea42bd530725190ddcb7d51f9badc6c3da372422 Mon Sep 17 00:00:00 2001 From: Alex Morehead Date: Wed, 22 May 2024 23:08:26 -0500 Subject: [PATCH] Configure docs deployment action --- .github/workflows/documentation.yaml | 27 +++++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/documentation.yaml diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml new file mode 100644 index 00000000..915f59f0 --- /dev/null +++ b/.github/workflows/documentation.yaml @@ -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 \ No newline at end of file diff --git a/README.md b/README.md index 7798e34d..5ccd4b62 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Comprehensive benchmarking of protein-ligand structure generation methods -[Documentation](https://posebench.github.io/) +[Documentation](https://bioinfomachinelearning.github.io/PoseBench/) ## Contents