Skip to content

Improve API documentation and setup pdoc #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Improve API documentation and setup pdoc #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ __pycache__
# tox
/.tox

# generated by pdoc
/docs

##
## Miscellaneous
##
Expand Down
9 changes: 8 additions & 1 deletion Justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down