From 5a9670efc3a38c70152b45b580ae7ac7f5511aa1 Mon Sep 17 00:00:00 2001 From: patrickscholz Date: Mon, 21 Oct 2024 12:29:02 +0200 Subject: [PATCH] Create sphinx-docs.yml --- .github/workflows/sphinx-docs.yml | 37 +++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/workflows/sphinx-docs.yml diff --git a/.github/workflows/sphinx-docs.yml b/.github/workflows/sphinx-docs.yml new file mode 100644 index 0000000..2a1ac26 --- /dev/null +++ b/.github/workflows/sphinx-docs.yml @@ -0,0 +1,37 @@ +name: Deploy Sphinx Documentation to GitHub Pages + +on: + push: + branches: + - main # Deploy when changes are pushed to the main branch + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout the repository + uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: 3.9 # Use an appropriate version for your project + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install sphinx sphinx-rtd-theme # Add other extensions if needed + pip install -e . # Install project dependencies + + - name: Build documentation + run: | + cd docs + make html # Build the Sphinx documentation + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v4 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/_build/html # Path to the built HTML files + destination_dir: ""