Added workflow to check documentation

.github/workflows/documentation.yaml

@@ -0,0 +1,18 @@
+name: documentation check
+
+on:
+  push:
+  pull_request:
+    branches: [ "master", "dev" , "experimental" ]
+
+jobs:
+  tests:
+    name: documentation check
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4.1.3
+    - name: Run script and save results
+      run: python docs/script/make_doc.py README.tmp
+    - name: Compare temp file with readme.rst
+      run: diff -u --strip-trailing-cr README.rst README.tmp

.gitignore

@@ -1,8 +1,9 @@
-# Gitignore settings for ESPHome
-/.esphome/
-__pycache__/
-/.vscode/
-/secrets.yaml
-/buildlog.txt
-*.bak
-*.local.yaml
+# Gitignore settings for ESPHome
+/.esphome/
+__pycache__/
+/.vscode/
+/secrets.yaml
+/buildlog.txt
+*.bak
+*.local.yaml
+*.tmp

README.rst

@@ -128,7 +128,6 @@ Automations
 
 ``on_alarm_start`` Trigger
 **************************
-
 This automation will be triggered when a new alarm is activated by AC. The error code of the alarm will be given in the variable "code" (type uint8_t), error message in the variable "message" (type char*). Those variables can be used in `lambdas <https://esphome.io/guides/automations#config-lambda>`_
 
 .. code-block:: yaml

docs/ESP32_backup.rst → docs/esp32_backup.rst

@@ -29,4 +29,3 @@ flash_4M.bin**
 
 After this, you can flash firmware using ESPHome tools (dashboard,
 website, esphome command, etc)
-

docs/script/make_doc.py

@@ -1,14 +1,15 @@
 import re
 import os
+import sys
 
 doc_file_path = [ 
-    'esphome-docs/climate/haier.rst',
-    'esphome-docs/sensor/haier.rst',
-    'esphome-docs/binary_sensor/haier.rst',
-    'esphome-docs/text_sensor/haier.rst',
-    'esphome-docs/button/haier.rst',
-    'esp32_backup.rst',
-    'additional_information.rst',
+    "/".join(["esphome-docs", "climate", "haier.rst"]),
+    "/".join(["esphome-docs", "sensor", "haier.rst"]),
+    "/".join(["esphome-docs", "binary_sensor", "haier.rst"]),
+    "/".join(["esphome-docs", "text_sensor", "haier.rst"]),
+    "/".join(["esphome-docs", "button", "haier.rst"]),
+    "esp32_backup.rst",
+    "additional_information.rst",
 ]
 
 def process_esphome_refs(line, l_num):
@@ -72,12 +73,16 @@ def process_section(section, output_file, pth):
     "   source documentation in ./doc folder or script.\n\n"
 ]
 
-output_file = open("../../README.rst", "w")
+script_path = os.path.dirname(__file__)
+output_file_name = "../../README.rst"
+if len(sys.argv) > 1:
+    output_file_name = sys.argv[1]
+output_file = open(output_file_name, "w")
 output_file.writelines(document_header)
 for in_f in doc_file_path:
     print(f"Processing: {in_f}")
     output_file.write(f".. Generated from {in_f}\n\n")
-    input_file = open(f"../{in_f}", "r")
+    input_file = open(os.path.join(script_path, "..", in_f), "r")
     p = os.path.dirname(in_f)
     lines = input_file.readlines()
     is_seo = False