Merge branch 'main' of github:SAFEHR-data/datafaker into remove-generator-file

Author: Tim Band

.github/workflows/docs.yml

@@ -0,0 +1,43 @@
+---
+name: Publish Documentation
+on:
+  push:
+    branches:
+      # need this to be able to run the workflow until it has been merged into main
+      - overview_documentation
+  workflow_dispatch:
+env:
+  PYTHON_VERSION: "3.12"
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "${{ env.PYTHON_VERSION }}"
+      - name: Install poetry
+        shell: bash
+        run: |
+          sudo apt install python3-poetry
+      - name: Configure poetry
+        shell: bash
+        run: |
+          poetry config virtualenvs.in-project true
+      - name: Install dependencies
+        shell: bash
+        run: |
+          poetry install --all-extras
+      - name: Build documentation
+        shell: bash
+        working-directory: ./docs
+        run: |
+          poetry run make html
+      - name: Publish docs on github Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/html
+          force_orphan: true

.gitignore

@@ -138,17 +138,18 @@ datafaker/config.ini
 
 # sphinx
 docs/build/*
+docs/esbonio-build/*
 docs/temp/*
 
 # vim swap files
 *.swp
 
 # tool outputs
-df.py
-ssg.py
-orm.yaml
-src-stats.yaml
-config.yaml
+/df.py
+/ssg.py
+/orm.yaml
+/src-stats.yaml
+/config.yaml
 *.yaml.gz
 
 *_stories.py

Dockerfile

@@ -1,5 +1,5 @@
 FROM python:3.13.3-alpine3.22
-RUN apk add bash poetry
+RUN apk add bash poetry build-base
 WORKDIR /app
 ADD . /app
 RUN mkdir /pypoetry