We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 7a33931 commit ee2a82fCopy full SHA for ee2a82f
.gitignore
@@ -20,6 +20,9 @@ __pycache__
20
# uv - libraries should not include lockfile
21
/uv.lock
22
23
+# generated by pdoc
24
+/docs
25
+
26
##
27
## Miscellaneous
28
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`
29
+#
30
+# See website: https://pdoc.dev/
31
+doc:
32
+ @mkdir -p docs
33
+ PYTHONPATH=src ./pdoc/.venv/bin/pdoc --docformat=markdown -o docs techcable.orderedset
34
35
mypy:
36
uv run mypy src
37
0 commit comments