From b5c723cfc9275f0844af5cf9f2b033c2f370f683 Mon Sep 17 00:00:00 2001 From: jurra Date: Mon, 25 Sep 2023 12:40:20 +0200 Subject: [PATCH] docs: setup github pages --- .github/workflows/docs.yaml | 39 +++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/workflows/docs.yaml diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 0000000..d72d052 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,39 @@ +name: deploy-documentation + +# Only run this when the master branch +on: + push: + branches: + - master + - develop + - feature/sphinx + # Option to run action manually + workflow_dispatch: + inputs: + tag: + description: Tag for manually deploying jupyterbook + required: False + default: "" + +# This job installs dependencies, builds the documentaiton, and pushes it to `gh-pages` +jobs: + deploy-book: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Python 3.8 + uses: actions/setup-python@v2 + with: + python-version: 3.8 + - name: Install dependencies + run: | + pip install -e .[dev] + - name: Build the documentation + run: | + cd docs + make html + touch _build/html/.nojekyll + - name: Deploy documentation + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: docs/_build/html \ No newline at end of file