Skip to content

Commit ee2a82f

Browse files
committed
TODO: Why isn't the markdown working properly?
1 parent 7a33931 commit ee2a82f

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ __pycache__
2020
# uv - libraries should not include lockfile
2121
/uv.lock
2222

23+
# generated by pdoc
24+
/docs
25+
2326
##
2427
## Miscellaneous
2528
##

Justfile

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,17 @@ fix: && _format fix-spelling
2121
@# Failure to fix should not prevent formatting
2222
-ruff check --fix src
2323

24-
build: mypy && _test check-format
24+
build: mypy && doc _test check-format
2525
# Build project
2626
uv build
2727

28+
# 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+
2835
mypy:
2936
uv run mypy src
3037

0 commit comments

Comments
 (0)