From f68a8522e8caf973574506f00812339dc18ee619 Mon Sep 17 00:00:00 2001 From: gnikit Date: Mon, 18 Jul 2022 11:21:56 +0100 Subject: [PATCH] Add docs GitHub Action This is a temporary solution until we figure out how to deploy readthedocs via GitHub Actions on a GitHub page. --- .github/workflows/docs.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..504cca3 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,18 @@ +name: "Docs" +on: [push, pull_request] + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: sphinx-toolbox/sphinx-action@master + with: + pre-build-command: "pip install .[docs]" + docs-folder: "docs/" + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: github.ref == 'refs/heads/main' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/_build/html