Enhance project configuration: add Sourcery pre-commit hook, update README for virtual environment setup, and improve dark/light mode palette in mkdocs.yml

Author: JakubAndrysek

.gitignore

@@ -290,4 +290,4 @@ tests/files/.mkdoxy
 temp/
 local/
 
-.idea/
+.idea/

.pre-commit-config.yaml

@@ -1,16 +1,28 @@
 ---
 repos:
+  - repo: https://github.com/sourcery-ai/sourcery
+    rev: v1.19.0
+    hooks:
+      - id: sourcery
+        # The best way to use Sourcery in a pre-commit hook:
+        # * review only changed lines:
+        # * omit the summary
+        args: [--diff=git diff HEAD, --no-summary]
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
   - repo: https://github.com/psf/black
     rev: 23.9.1
     hooks:
       - id: black
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.292'
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.9.6
     hooks:
+      # Run the linter.
       - id: ruff
-        args: [--fix, --exit-non-zero-on-fix]
+        args: [ --fix, --exit-non-zero-on-fix ]
+      # Run the formatter.
+      - id: ruff-format

README.md

@@ -41,6 +41,7 @@ pip install mkdoxy
 ```
 Development version with all dependencies:
 ```bash
+python -m venv .venv
 python -m pip install mkdoxy ".[dev]"
 ```
 

mkdocs.yml

@@ -25,9 +25,23 @@ theme:
     repo: fontawesome/brands/github
 
   palette:
-    - scheme: slate
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
       primary: orange
       accent: orange
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: orange
+      accent: orange
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
 
 extra:
   social: