oe-python-template 0.6.26__tar.gz → 0.6.27__tar.gz

{oe_python_template-0.6.26 → oe_python_template-0.6.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.6.26
+Version: 0.6.27
 Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/

{oe_python_template-0.6.26 → oe_python_template-0.6.27}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.6.26"
+version = "0.6.27"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [
@@ -79,9 +79,15 @@ Changelog = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-templat
 Issues = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues"
 
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling==1.27.0"]
 build-backend = "hatchling.build"
 
+[tool.hatch.build]
+include = ["src/*"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/oe_python_template"]
+
 [project.optional-dependencies]
 examples = [
     "streamlit>=1.43.2",
@@ -242,7 +248,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.6.26"
+current_version = "0.6.27"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

oe_python_template-0.6.26/.act-env-public

@@ -1 +0,0 @@
-GITHUB_WORKFLOW_RUNTIME=ACT

oe_python_template-0.6.26/.copier-answers.yml

@@ -1,23 +0,0 @@
-_commit: v0.6.25-1-gfb4e83c
-_src_path: .
-author_email: helmuthva@gmail.com
-author_github_username: helmut-hoffer-von-ankershoffen
-author_name: Helmut Hoffer von Ankershoffen
-docker_io_enabled: true
-docker_io_image_name: oe-python-template
-docker_io_owner: helmuthva
-github_repository_name: oe-python-template
-github_repository_owner: helmut-hoffer-von-ankershoffen
-github_repository_url_https: https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template
-github_repository_url_ssh: git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template.git
-org_email: helmuthva@gmail.com
-org_name: Helmut Hoffer von Ankershoffen
-project_description: Copier template to scaffold Python projects compliant with best
-    practices and modern tooling.
-project_icon: 🧠
-project_name: OE Python Template
-pypi_distribution_name: oe-python-template
-readthedocs_domain: readthedocs.org
-readthedocs_project_key: oe-python-template
-sonarqube_key: helmut-hoffer-von-ankershoffen_oe-python-template
-streamlit_project_key: oe-python-template

oe_python_template-0.6.26/.devcontainer/Dockerfile

@@ -1,7 +0,0 @@
-FROM mcr.microsoft.com/devcontainers/python:1-3.11-bullseye
-
-RUN curl --proto '=https' --tlsv1.2 -fsSL https://deb.nodesource.com/setup_22.x | bash - && \
-    apt update -y && \
-    apt install -y --no-install-recommends curl gnupg2 jq less nano nodejs procps psmisc && \
-    apt-get clean && \
-    rm -rf /var/lib/apt/lists/*

oe_python_template-0.6.26/.devcontainer/devcontainer.json

@@ -1,51 +0,0 @@
-{
-	"build": {
-		"dockerfile": "Dockerfile"
-	},
-	"features": {
-		"ghcr.io/devcontainers/features/github-cli:1": {},
-		"ghcr.io/va-h/devcontainers-features/uv:1": {},
-		"ghcr.io/dhoeric/features/act:1": {},
-		"ghcr.io/devcontainers/features/docker-in-docker:2": {},
-		"ghcr.io/devcontainers/features/java:1": {},
-		"ghcr.io/devcontainers/features/node:1": {}
-	},
-	"onCreateCommand": ".devcontainer/onCreateCommand",
-	"postCreateCommand": ".devcontainer/postCreateCommand",
-	"postAttachCommand": ".devcontainer/postAttachCommand",
-	"customizations": {
-		// Configure properties specific to VS Code.
-		"vscode": {
-			// Add the IDs of extensions you want installed when the container is created.
-			"extensions": [
-				"charliermarsh.ruff",
-				"codecov.codecov",
-				"donjayamanne.python-environment-manager",
-				"fill-labs.dependi",
-				"github.vscode-github-actions",
-				"github.copilot",
-				"github.copilot-chat",
-				"gruntfuggly.todo-tree",
-		        "joshrmosier.streamlit-runner",
-				"kaih2o.python-resource-monitor",
-		        "marimo-team.vscode-marimo",
-				"mikestead.dotenv",
-				"ms-azuretools.vscode-docker",
-				"ms-python.debugpy",
-				"ms-python.python",
-				"ms-python.vscode-pylance",
-				"ms-toolsai.jupyter",
-				"oderwat.indent-rainbow",
-				"samuelcolvin.jinjahtml",
-				"sonarsource.sonarlint-vscode",
-				"tamasfe.even-better-toml",
-				"tomoki1207.pdf",
-				"wayou.vscode-todo-highlight"
-			]
-		}
-	},
-	"mounts": [
-		"source=${localEnv:HOME}/.ssh,target=/home/vscode/.ssh,type=bind,consistency=cached"
-	],
-	"forwardPorts": []
-}

oe_python_template-0.6.26/.devcontainer/onCreateCommand

@@ -1,9 +0,0 @@
-#!/bin/sh
-
-echo "onCreateCommand: start"
-git config --global --add safe.directory /workspaces/oe-python-template
-rm -rf .nox
-rm -rf .venv
-uv sync --frozen
-uv run pre-commit install
-echo "onCreateCommand: end"

oe_python_template-0.6.26/.devcontainer/postAttachCommand

@@ -1,4 +0,0 @@
-#!/bin/sh
-
-echo "postAttachCommand:start"
-echo "postAttachCommand:end"

oe_python_template-0.6.26/.devcontainer/postCreateCommand

@@ -1,4 +0,0 @@
-#!/bin/sh
-
-echo "postCreateCommand:start"
-echo "postCreateCommand:end"

oe_python_template-0.6.26/.env.example

@@ -1 +0,0 @@
-THE_KEY=A value

oe_python_template-0.6.26/.github/copilot-instructions.md

@@ -1,5 +0,0 @@
-Always conform to the coding styles defined in CODE_STYLE.md in the root
-directory of this repository when generating code.
-
-Learn about tools to use in CONTRIBUTING.md in the root directory of this
-repository.

oe_python_template-0.6.26/.github/dependabot.yml

@@ -1,13 +0,0 @@
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
-  - package-ecosystem: "pip"
-    directory: "/"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"

oe_python_template-0.6.26/.github/workflows/codeql.yml

@@ -1,100 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL Advanced"
-
-on:
-  push:
-    branches: ["main"]
-  pull_request:
-    branches: ["main"]
-  schedule:
-    - cron: "22 3 * * 2"
-
-jobs:
-  analyze:
-    name: Analyze (${{ matrix.language }})
-    # Runner size impacts CodeQL analysis time. To learn more, please see:
-    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
-    #   - https://gh.io/supported-runners-and-hardware-resources
-    #   - https://gh.io/using-larger-runners (GitHub.com only)
-    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
-    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
-    permissions:
-      # required for all workflows
-      security-events: write
-
-      # required to fetch internal or private CodeQL packs
-      packages: read
-
-      # only required for workflows in private repositories
-      actions: read
-      contents: read
-
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - language: actions
-            build-mode: none
-          - language: python
-            build-mode: none
-          # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
-          # Use `c-cpp` to analyze code written in C, C++ or both
-          # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
-          # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
-          # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
-          # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
-          # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
-          # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-        # Add any setup steps before running the `github/codeql-action/init` action.
-      # This includes steps like installing compilers or runtimes (`actions/setup-node`
-      # or others). This is typically only required for manual builds.
-      # - name: Setup runtime (example)
-      #   uses: actions/setup-example@v1
-
-      # Initializes the CodeQL tools for scanning.
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
-        with:
-          languages: ${{ matrix.language }}
-          build-mode: ${{ matrix.build-mode }}
-          # If you wish to specify custom queries, you can do so here or in a config file.
-          # By default, queries listed here will override any specified in a config file.
-          # Prefix the list here with "+" to use these queries and those in the config file.
-
-          # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-          queries: security-extended,security-and-quality
-
-      # If the analyze step fails for one of the languages you are analyzing with
-      # "We were unable to automatically build your code", modify the matrix above
-      # to set the build mode to "manual" for that language. Then modify this step
-      # to build your code.
-      # ℹ️ Command-line programs to run using the OS shell.
-      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-      - if: matrix.build-mode == 'manual'
-        shell: bash
-        run: |
-          echo 'If you are using a "manual" build mode for one or more of the' \
-            'languages you are analyzing, replace this with the commands to build' \
-            'your code, for example:'
-          echo '  make bootstrap'
-          echo '  make release'
-          exit 1
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
-        with:
-          category: "/language:${{matrix.language}}"

oe_python_template-0.6.26/.github/workflows/docker-image-build-publish.yml

@@ -1,93 +0,0 @@
-name: "Build and publish Docker image to docker.io and ghcr.io"
-
-on:
-  push:
-    tags:
-      - "v*.*.*"
-
-
-env:
-  REGISTRY: docker.io
-  IMAGE_NAME: helmuthva/oe-python-template
-
-
-jobs:
-  docker_image_build_publish:
-    runs-on: ubuntu-latest
-    permissions:
-      packages: write
-      contents: read
-      attestations: write
-      id-token: write
-    steps:
-      - name: Checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3.6.0
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3.10.0
-
-
-
-      - name: Log in to Docker Hub
-        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
-        with:
-
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
-
-
-
-      - name: Log in to GitHub container registry
-        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
-        with:
-          registry: ghcr.io
-
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5.7.0
-        with:
-
-
-          images: |
-            ${{ env.IMAGE_NAME }}
-            ghcr.io/${{ github.repository }}
-
-
-
-          tags: |
-            # set latest tag for releases
-            type=raw,value=latest
-            # set semver tags from git tags (v1.2.3 -> 1.2.3, 1.2, 1)
-            type=semver,pattern={{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-
-
-
-      - name: Build and push Docker image
-        id: push
-        uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # v6.15.0
-        with:
-          context: .
-          file: ./Dockerfile
-          platforms: linux/amd64,linux/arm64
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-
-
-
-
-      - name: Generate artifact attestation
-        uses: actions/attest-build-provenance@c074443f1aee8d4aeeae555aebba3282517141b2 # v2.2.3
-        with:
-          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
-          subject-digest: ${{ steps.push.outputs.digest }}
-          push-to-registry: true

oe_python_template-0.6.26/.github/workflows/package-build-publish-release.yml

@@ -1,63 +0,0 @@
-name: "Build package, publish to PyPI, create GitHub release"
-
-on:
-  push:
-    tags:
-      - "v*.*.*"
-
-
-jobs:
-  package_build_publish_release:
-    environment: release
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      packages: read
-    steps:
-      - name: Checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-        with:
-          fetch-depth: 0
-
-      - name: Generate release notes
-        uses: orhun/git-cliff-action@4a4a951bc43fafe41cd2348d181853f52356bee7 # v4.4.2
-        id: git-cliff
-        with:
-          config: pyproject.toml
-          args: --verbose --latest --strip header
-        env:
-          OUTPUT: RELEASE_NOTES.md
-          GITHUB_REPO: ${{ github.repository }}
-
-      - name: Print the release notes
-        run: cat "${{ steps.git-cliff.outputs.changelog }}"
-
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@f94ec6bedd8674c4426838e6b50417d36b6ab231 # v5.3.1
-        with:
-          version: "0.6.3"
-          cache-dependency-glob: uv.lock
-          enable-cache: true
-
-      - name: Build package into dist/
-        run: uv build
-
-      - name: Publish package to PyPI
-        run: uv publish -t ${{ secrets.UV_PUBLISH_TOKEN }}
-
-      - name: Build package into dist/
-        run: uv run nox -s audit
-
-      - name: Create GitHub release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          gh release create ${{ github.ref_name }} ./dist/* ./reports/* --notes-file ${{ steps.git-cliff.outputs.changelog }}
-
-      - name: Allow other workflows to trigger on release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          gh api repos/helmut-hoffer-von-ankershoffen/oe-python-template/dispatches \
-            -f event_type=release_created_programatically

oe_python_template-0.6.26/.github/workflows/test-and-report.yml

@@ -1,113 +0,0 @@
-name: "CI"
-
-on:
-  push:
-    branches:
-      - "**"
-  pull_request:
-    branches: [main]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    permissions:
-      packages: write
-      contents: read
-      attestations: write
-      id-token: write
-    steps:
-      - name: Checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-        with:
-          fetch-depth: 0
-
-      - name: Install dependencies
-        run: |
-          sudo apt-get update && sudo apt-get install -y libcairo2
-
-      - name: Install dev tools
-        run: |
-          sudo apt-get install -y curl jq xsltproc gnupg2 libcairo2
-
-      - name: Install uv (python package manager)
-        uses: astral-sh/setup-uv@f94ec6bedd8674c4426838e6b50417d36b6ab231 # v5.3.1
-        with:
-          version: "0.6.3"
-          enable-cache: true
-          cache-dependency-glob: uv.lock
-
-      - name: Install Python, venv and dependencies
-        run: |
-          uv sync --all-extras --frozen --link-mode=copy
-
-      - name: Release version check
-        if: startsWith(github.ref, 'refs/tags/v')
-        run: |
-          TAG_VERSION=${GITHUB_REF#refs/tags/v}
-          TOML_VERSION=$(uv run python -c "import tomli; print(tomli.load(open('pyproject.toml', 'rb'))['project']['version'])")
-
-          if [ "$TAG_VERSION" != "$TOML_VERSION" ]; then
-            echo "Release version mismatch: Tag $TAG_VERSION != pyproject.toml $TOML_VERSION"
-            exit 1
-          fi
-
-      - name: Print development version info
-        if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
-        run: |
-          TOML_VERSION=$(uv run python -c "import tomli; print(tomli.load(open('pyproject.toml', 'rb'))['project']['version'])")
-          echo "Development build - Current version in pyproject.toml: $TOML_VERSION"
-
-      - name: Create .env file
-        uses: SpicyPizza/create-envfile@ace6d4f5d7802b600276c23ca417e669f1a06f6f # v2.0.3
-        with:
-          envkey_ENV_KEY: "ENV_VALUE"
-          fail_on_empty: true
-
-      - name: Validate installation
-        run: |
-            OUTPUT=$(uv run oe-python-template --help)
-            if [[ "$OUTPUT" != *"built with love in Berlin"* ]]; then
-            echo "Output does not contain 'built with love in Berlin'"
-            exit 1
-            fi
-
-      - name: Smoke tests
-        run: |
-          uv run oe-python-template hello-world
-
-      - name: Run unit tests, measure coverage, lint, and check vulnerabilities
-        run: |
-          uv run nox
-
-      - name: Upload test results
-        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
-        if: ${{ always() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
-        with:
-          name: test-results
-          path: |
-            junit.xml
-            coverage.xml
-            coverage_html/
-            vulnerabilities.json
-            licenses.json
-            licenses-inverted.json
-          retention-days: 30
-
-      - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@0565863a31f2c772f9f0395002a31e3f06189574 # v5.4.0
-        if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          slug: helmut-hoffer-von-ankershoffen/oe-python-template
-
-      - name: Upload test results to Codecov
-        if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
-        uses: codecov/test-results-action@f2dba722c67b86c6caa034178c6e4d35335f6706 # v1.1.0
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-      - name: SonarQube Scan
-        if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
-        uses: SonarSource/sonarqube-scan-action@0303d6b62e310685c0e34d0b9cde218036885c4d # v5.0.0
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

oe_python_template-0.6.26/.pre-commit-config.yaml

@@ -1,76 +0,0 @@
-# .pre-commit-config.yaml
-default_install_hook_types:
-  - pre-commit
-  - post-checkout
-  - post-merge
-  - post-rewrite
-fail_fast: true
-repos:
-  - repo: meta
-    hooks:
-      - id: check-useless-excludes
-  - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.10.0
-    hooks:
-      - id: python-check-blanket-noqa
-      - id: python-check-blanket-type-ignore
-        exclude: "^examples/notebook.py$"
-      - id: python-check-mock-methods
-      - id: python-no-eval
-      - id: python-no-log-warn
-      - id: python-use-type-annotations
-      - id: rst-backticks
-      - id: rst-directive-colons
-      - id: rst-inline-touching-normal
-      - id: text-unicode-replacement-char
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
-    hooks:
-      - id: check-added-large-files
-      - id: check-case-conflict
-      - id: check-illegal-windows-names
-      - id: check-merge-conflict
-        args: ["--assume-in-merge"]
-      - id: check-shebang-scripts-are-executable
-      - id: check-symlinks
-      - id: check-toml
-      - id: check-xml
-      - id: check-yaml
-        exclude: |
-          (?x)^(
-            test.*|
-            mkdocs.yml
-          )$
-        args: [--allow-multiple-documents]
-      - id: debug-statements
-      - id: destroyed-symlinks
-      - id: detect-private-key
-      - id: end-of-file-fixer
-        exclude: "^tests/fixtures/|.json$"
-      - id: fix-byte-order-marker
-      - id: fix-encoding-pragma
-        args: ["--remove"]
-      - id: mixed-line-ending
-      - id: name-tests-test
-      - id: requirements-txt-fixer
-      - id: trailing-whitespace
-        exclude: "docs/source/_static"
-  - repo: https://github.com/Yelp/detect-secrets
-    rev: v1.5.0
-    hooks:
-      - id: detect-secrets
-        args: ['--baseline', '.secrets.baseline']
-        additional_dependencies: ["gibberish-detector"]
-  - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.6.5
-    hooks:
-      - id: uv-lock
-  - repo: local
-    hooks:
-      - id: nox
-        name: nox
-        entry: uv run nox
-        language: system
-        pass_filenames: false
-        always_run: true
-        verbose: true

oe_python_template-0.6.26/.python-version

@@ -1 +0,0 @@
-3.11

oe_python_template-0.6.26/.readthedocs.yml

@@ -1,36 +0,0 @@
-# Read the Docs configuration file for OE Python Template
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Don't publish the docs if there are any warnings, as they might be relevant
-# https://github.com/readthedocs/readthedocs.org/issues/6837#issuecomment-607229633
-sphinx:
-  builder: html
-  configuration: docs/source/conf.py
-  fail_on_warning: true
-
-# Formats of the documentation to be built
-formats:
-  - htmlzip
-  - pdf
-
-# Build configuration
-# We use Ubuntu 22.04 with Python 3.12 and set up uv as package manager
-# for faster and more reliable dependency installation
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.12"
-  apt_packages:
-    - imagemagick
-  jobs:
-    install:
-      - asdf plugin add uv
-      - asdf install uv latest
-      - asdf global uv latest
-      - echo $READTHEDOCS_VIRTUALENV_PATH
-      - uv venv $READTHEDOCS_VIRTUALENV_PATH
-      - . ${READTHEDOCS_VIRTUALENV_PATH}/bin/activate
-      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --frozen --all-extras