mkdocs

.github/workflows/run-unittest.yml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.11, 3.12, 3.13]
+        python-version: [3.11, 3.12]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}

Makefile

@@ -3,4 +3,4 @@ export TAG := `grep version pyproject.toml | pz --search '"(\d+\.\d+\.\d+(?:rc\d
 release:
 	git tag $(TAG)
 	git push origin $(TAG)
-	#mkdocs gh-deploy
+	mkdocs gh-deploy

README.md

@@ -0,0 +1 @@
+docs/index.md

deduplidog/deduplidog.py

@@ -37,6 +37,8 @@
 
 @dataclass
 class Action:
+    """ What is to be done with the duplicates. """
+
     execute: bool = False
     "If False, nothing happens, just a safe run is performed."
 
@@ -63,6 +65,8 @@ class Action:
 
 @dataclass
 class Execution:
+    """ Parameters affecting the way the execution runs. """
+
     set_both_to_older_date: bool = False
     "If `execute=True`, `media_magic=True` or (media_magic=False and `ignore_date=True`), both files are set to the older date. Ex: work file get's the original file's date or vice versa."
 
@@ -85,6 +89,8 @@ class Execution:
 
 @dataclass
 class Match:
+    """ The way the files are compared. """
+
     casefold: bool = False
     "Case insensitive file name comparing."
     checksum: bool = False
@@ -123,6 +129,7 @@ class Match:
 
 @dataclass
 class Media:
+    """ Media files similarity detection. """
 
     media_magic: bool = False
     """ Media files similarity detection.
@@ -146,6 +153,8 @@ class Media:
 
 @dataclass
 class Helper:
+    """ Helper settings. """
+
     log_level: int = logging.WARNING
     "10 debug .. 50 critical"  # NOTE check
 

docs/Changelog.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.7.0 (2025-01-09)
+Working as expected.

docs/Overview.md

@@ -0,0 +1,22 @@
+## Deduplidog overview
+
+Launch `deduplidog` and change these parameter from GUI/TUI, or set them via CLI.
+
+::: deduplidog.Deduplidog
+    options:
+        members:
+          - work_dir
+          - original_dir
+        show_aliases: false
+        show_source: false
+
+# Action
+::: deduplidog.deduplidog.Action
+# Execution
+::: deduplidog.deduplidog.Execution
+# Match
+::: deduplidog.deduplidog.Match
+# Media
+::: deduplidog.deduplidog.Media
+# Helper
+::: deduplidog.deduplidog.Helper