fix: docs build to throw error if fails (#1100)

* fix: docs build to throw error if fails

* docs: members init should be array

Author: inimaz

.github/workflows/build-docs.yml

@@ -14,6 +14,7 @@ on:
     paths:
       - "docs/**"
       - "mkdocs.yml"
+      - ".github/workflows/build-docs.yml"
 
 jobs:
   build:
@@ -33,4 +34,12 @@ jobs:
         run: uv sync --group doc
 
       - name: Build docs
-        run: uv run zensical build -f mkdocs.yml --clean
+        run: |
+          set -euo pipefail
+          # Run zensical and capture output, fail if command exits non-zero
+          uv run zensical build -f mkdocs.yml --clean 2>&1 | tee docs_build.log
+          # If output contains common error indicators, fail the step.
+          if grep -Ei "\b(error|failed|traceback|exception)\b" docs_build.log >/dev/null; then
+            echo "Documentation build produced errors; failing workflow."
+            exit 1
+          fi

docs/getting-started/parameters.md

@@ -19,7 +19,8 @@ All parameters are documented below:
 
 ::: codecarbon.emissions_tracker.BaseEmissionsTracker
     options:
-      members: __init__
+      members: 
+        - __init__
       merge_init_into_class: true
       show_root_heading: true
       show_signature: false
@@ -30,7 +31,8 @@ All parameters are documented below:
 
 ::: codecarbon.emissions_tracker.OfflineEmissionsTracker
     options:
-      members: __init__
+      members: 
+        - __init__
       merge_init_into_class: true
       show_root_heading: true
       show_signature: false