From 46ec800ae6241cd11a214fd5ced972f231f5c9ba Mon Sep 17 00:00:00 2001 From: "Christoph J. Scherr" Date: Fri, 14 Mar 2025 16:55:37 +0100 Subject: [PATCH] chore: setup a simple generation for the documentation Refs: OPS-64 --- .github/workflows/gendocs.yml | 38 +++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/gendocs.yml diff --git a/.github/workflows/gendocs.yml b/.github/workflows/gendocs.yml new file mode 100644 index 0000000..d094fa1 --- /dev/null +++ b/.github/workflows/gendocs.yml @@ -0,0 +1,38 @@ +name: Build and Store Documentation Artifact + +on: + push: + branches: + - master + - devel + pull_request: + branches: + - master + - devel + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v3 + with: + python-version: '3.11' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install sphinx + - name: Build Sphinx documentation + run: | + cd docs + sphinx-apidoc -o source/_modules ../senju + make html + - name: Upload documentation artifact + uses: actions/upload-artifact@v4 + with: + name: documentation-artifact + path: docs/build/html + # TODO: upload artifact for gh pages + # TODO: deploy to gh pages