Closes #265: Enable pre-commit (#273)

* Closes #265: Enable pre-commit

* Clean up rendered docs after testing 'mkdocs build'

* Omit Django checks for brevity

Author: jeremystretch

.hooks/mkdocs-build.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -euo pipefail
+
+echo "Running mkdocs build..."
+
+TEMP_SITE_DIR=$(mktemp -d)
+
+# Run mkdocs build into temp dir
+if mkdocs build --site-dir "$TEMP_SITE_DIR" --strict; then
+    echo "Build successful."
+else
+    echo "Build failed." >&2
+    exit 1
+fi
+
+# Cleanup
+rm -rf "$TEMP_SITE_DIR"

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.11.12
+  hooks:
+    - id: ruff
+      name: "Ruff linter"
+      args: [ netbox_branching/ ]
+- repo: local
+  hooks:
+    - id: mkdocs-build
+      name: "Build documentation"
+      description: "Build the documentation with mkdocs"
+      files: 'docs/'
+      entry: .hooks/mkdocs-build.sh
+      language: system
+      pass_filenames: false