[pull] current from esphome:current

.devcontainer/devcontainer.json

@@ -1,27 +1,20 @@
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.183.0/containers/python-3
 {
-    "name": "ESPHome - docs",
-    "image": "mcr.microsoft.com/vscode/devcontainers/python:0-3.6",
-    "postCreateCommand": "pip3 install -r requirements.txt -r requirements_test.txt",
-    "forwardPorts": [8000],
-    "settings": { 
-        "python.pythonPath": "/usr/local/bin/python",
-        "python.languageServer": "Pylance",
-        "python.linting.enabled": true,
-        "python.linting.pylintEnabled": true,
-        "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
-        "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
-        "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
-        "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
-        "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
-        "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
-        "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
-        "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
-        "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
-    },
+  "name": "ESPHome - docs",
+  "image": "mcr.microsoft.com/vscode/devcontainers/python:0-3.11",
+  "postCreateCommand": ".devcontainer/postCreate.sh",
+  "postAttachCommand": "make live-html",
+  "forwardPorts": [8000],
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1": {}
+  },
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "python.pythonPath": "/usr/local/bin/python"
+      },
 
-    "extensions": [
-        "ms-python.python",
-        "ms-python.vscode-pylance"
-    ]
+      "extensions": ["ms-python.python"]
+    }
+  }
 }

.devcontainer/postCreate.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+
+pip3 install -r requirements.txt -r requirements_test.txt
+curl -L https://github.com/CloudCannon/pagefind/releases/download/v1.1.0/pagefind-v1.1.0-x86_64-unknown-linux-musl.tar.gz | tar -xz -C ~/.local/bin

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,5 +7,8 @@
 
 ## Checklist:
 
-  - [ ] Branch: `next` is for changes and new documentation that will go public with the next ESPHome release. Fixes, changes and adjustments for the current release should be created against `current`.
+  - [ ] I am merging into `next` because this is new documentation that has a matching pull-request in [esphome](https://github.com/esphome/esphome) as linked above.  
+    or
+  - [ ] I am merging into `current` because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.
+
   - [ ] Link added in `/index.rst` when creating new documents for new components or cookbook.

.github/dependabot.yml

@@ -5,3 +5,7 @@ updates:
     schedule:
       interval: daily
     open-pull-requests-limit: 10
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: daily

.github/workflows/component-image.yml

@@ -0,0 +1,68 @@
+name: Component Image Generator
+
+on:
+  issue_comment:
+    types: [created]
+
+permissions:
+  pull-requests: write
+
+jobs:
+  prepare:
+    name: Prepare
+    if: github.event.issue.pull_request && startsWith(github.event.comment.body, '@esphomebot generate image')
+    runs-on: ubuntu-latest
+    outputs:
+      name: ${{ steps.get_component.outputs.name }}
+      name_lower: ${{ steps.get_component.outputs.name_lower }}
+      comment_id: ${{ steps.create-comment.outputs.result }}
+    steps:
+      - name: Comment
+        id: create-comment
+        uses: actions/[email protected]
+        with:
+          script: |
+            const result = await github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `@${context.actor} Generating image...`
+            })
+            return result.data.id
+
+      - name: Get Component name
+        id: get_component
+        run: |-
+          comment="${{ github.event.comment.body }}"
+          component=$(echo $comment | sed -n 's/^@esphomebot generate image //p')
+          echo "name=$component" >> $GITHUB_OUTPUT
+          echo "name_lower=${component,,}" >> $GITHUB_OUTPUT
+
+  generate:
+    name: Generate
+    if: github.event.issue.pull_request && startsWith(github.event.comment.body, '@esphomebot generate image')
+    runs-on: ubuntu-latest
+    needs: prepare
+    steps:
+      - name: Generate
+        uses: esphome/[email protected]
+        with:
+          component: ${{ needs.prepare.outputs.name }}
+
+      - name: Upload
+        uses: actions/[email protected]
+        id: upload-artifact
+        with:
+          name: ${{ needs.prepare.outputs.name }}
+          path: ${{ needs.prepare.outputs.name_lower }}.svg
+
+      - name: Update Comment
+        uses: actions/[email protected]
+        with:
+          script: |
+            await github.rest.issues.updateComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              comment_id: ${{ needs.prepare.outputs.comment_id }},
+              body: `@${context.actor} Here is the image for the component ${{ steps.upload-artifact.outputs.artifact-url }}`
+            })

.github/workflows/docker.yml

@@ -9,6 +9,11 @@ on:
       - requirements.txt
       - Dockerfile
       - .github/workflows/docker.yml
+  pull_request:
+    paths:
+      - requirements.txt
+      - Dockerfile
+      - .github/workflows/docker.yml
 
 permissions:
   contents: read
@@ -18,31 +23,42 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
+      -
+        name: Install pagefind
+        uses: jaxxstorm/[email protected]
+        with:
+          repo: cloudcannon/pagefind
       -
         name: Checkout source code
-        uses: actions/[email protected]
+        uses: actions/[email protected]
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
       -
         name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
       -
         name: Login to DockerHub
-        uses: docker/login-action@v2
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USER }}
           password: ${{ secrets.DOCKER_PASSWORD }}
       - name: Login to GitHub Container Registry
-        uses: docker/login-action@v2
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
       -
         name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v6
         with:
           context: .
-          push: true
+          push: ${{ github.event_name != 'pull_request' }}
+          platforms: linux/amd64,linux/arm64
           tags: |
             esphome/esphome-docs:latest
             ghcr.io/esphome/esphome-docs:latest

.github/workflows/lint.yml

@@ -10,7 +10,7 @@ on:
 
 permissions:
   contents: read
-  
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
@@ -19,11 +19,15 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/[email protected]
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v4
+    - name: Install pagefind
+      uses: jaxxstorm/[email protected]
+      with:
+          repo: cloudcannon/pagefind
+    - uses: actions/[email protected]
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v5
       with:
-        python-version: 3.8
+        python-version: 3.12
     - name: Install dependencies
       run: pip install -r requirements.txt -r requirements_test.txt
     - name: Register problem matchers

.github/workflows/lock.yml

@@ -16,7 +16,7 @@ jobs:
   lock:
     runs-on: ubuntu-latest
     steps:
-      - uses: dessant/lock-threads@v3
+      - uses: dessant/lock-threads@v4
         with:
           pr-inactive-days: "1"
           pr-lock-reason: ""

.github/workflows/stale.yml

@@ -16,7 +16,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v5
+      - uses: actions/stale@v8
         with:
           days-before-pr-stale: 60
           days-before-pr-close: 7
@@ -35,7 +35,7 @@ jobs:
   close-issues:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v5
+      - uses: actions/stale@v8
         with:
           days-before-pr-stale: -1
           days-before-pr-close: -1

.gitignore

@@ -11,3 +11,8 @@ venv
 .vscode
 *.DS_Store
 /.idea/
+
+_pagefind/
+
+# Vim
+*.swp

.gitpod.yml

@@ -4,4 +4,4 @@ ports:
 
 tasks:
 - before: pip3 install -r requirements.txt
-  command: make webserver
+  command: make live-html

.pre-commit-config.yaml

@@ -1,15 +1,15 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-  - repo: https://github.com/ambv/black
-    rev: 20.8b1
+  - repo: https://github.com/psf/black
+    rev: 23.1.0
     hooks:
     - id: black
       args:
         - --safe
         - --quiet
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.4
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.0.0
     hooks:
       - id: flake8
         additional_dependencies:

.vscode/tasks.json

@@ -0,0 +1,11 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Live HTML build",
+      "type": "shell",
+      "command": "make live-html",
+      "problemMatcher": []
+    },
+  ]
+}

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.8-slim
+FROM python:3.12-slim
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
         curl \
@@ -9,10 +9,39 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
         software-properties-common \
         && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/*
 
-COPY requirements.txt .
-RUN pip3 install --no-cache-dir --no-binary :all: -r requirements.txt
+ENV PAGEFIND_VERSION="1.1.0"
+ARG TARGETARCH
+SHELL ["/bin/bash", "-c"]
+RUN <<EOF
+    export TARGETARCH=${TARGETARCH/arm64/aarch64}
+    export TARGETARCH=${TARGETARCH/amd64/x86_64}
+    curl -o pagefind.tar.gz https://github.com/CloudCannon/pagefind/releases/download/v$PAGEFIND_VERSION/pagefind-v$PAGEFIND_VERSION-$TARGETARCH-unknown-linux-musl.tar.gz -L
+    tar xzf pagefind.tar.gz
+    rm pagefind.tar.gz
+    mv pagefind /usr/bin
+    chmod +x /usr/bin/pagefind
+EOF
+
+RUN useradd -ms /bin/bash esphome
+
+
+USER esphome
+
+WORKDIR /workspaces/esphome-docs
+ENV PATH="${PATH}:/home/esphome/.local/bin"
+
+COPY requirements.txt ./
+RUN pip3 install --no-cache-dir -r requirements.txt
 
 EXPOSE 8000
-WORKDIR /data/esphomedocs
 
 CMD ["make", "live-html"]
+
+LABEL \
+        org.opencontainers.image.title="esphome-docs" \
+        org.opencontainers.image.description="An image to help with ESPHomes documentation development" \
+        org.opencontainers.image.vendor="ESPHome" \
+        org.opencontainers.image.licenses="CC BY-NC-SA 4.0" \
+        org.opencontainers.image.url="https://esphome.io" \
+        org.opencontainers.image.source="https://github.com/esphome/esphome-docs" \
+        org.opencontainers.image.documentation="https://github.com/esphome/esphome-docs/blob/current/README.md"

Doxygen

@@ -38,7 +38,7 @@ PROJECT_NAME           = "ESPHome"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2022.9.1
+PROJECT_NUMBER         = 2024.12.2
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a