From 67d50756b6a17bc562969d9d2b83709484489afa Mon Sep 17 00:00:00 2001
From: Techcable <git@techcable.net>
Date: Sun, 8 Jun 2025 12:34:07 -0700
Subject: [PATCH] wip: Use pdoc to generate API documentation

Not working correctly:
- Why isn't the markdown working properly? - Links are broken
- Issues with intra-doc links not working as I want them too
---
 .gitignore | 3 +++
 Justfile   | 9 ++++++++-
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index 84ff904..b89fb94 100644
--- a/.gitignore
+++ b/.gitignore
@@ -23,6 +23,9 @@ __pycache__
 # tox
 /.tox
 
+# generated by pdoc
+/docs
+
 ##
 ## Miscellaneous
 ##
diff --git a/Justfile b/Justfile
index d493acb..a365ba4 100644
--- a/Justfile
+++ b/Justfile
@@ -21,10 +21,17 @@ fix: && _format fix-spelling
     @# Failure to fix should not prevent formatting
     -ruff check --fix src
 
-build: mypy && _test check-format
+build: mypy && doc _test check-format
     # Build project
     uv build
 
+# build project documentation with `pdoc`
+#
+# See website: https://pdoc.dev/
+doc:
+    @mkdir -p docs
+    PYTHONPATH=src ./pdoc/.venv/bin/pdoc --docformat=markdown -o docs techcable.orderedset
+
 mypy:
     uv run mypy src