Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ test:
all-checks: static-checks test
@echo "✅ Great success!"

docs-serve:
uv run mkdocs serve

docs-build:
uv run mkdocs build

docs-deploy:
uv run mkdocs gh-deploy

clean:
rm -rf dist

Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -507,6 +507,19 @@ make format
make all-checks
```

#### Docs

The documentation is hosted on [GitHub Pages](https://labelformat.com) and built with [MkDocs](https://www.mkdocs.org/).

```bash
# Serve docs locally with live reload
make docs-serve

# Deploy to GitHub Pages https://labelformat.com (builds and pushes in one step)
# Requires push access to the repo — only run from main with a clean working tree
make docs-deploy
```

## Maintained By
[Lightly](https://www.lightly.ai) is a spin-off from ETH Zurich that helps companies
build efficient active learning pipelines to select the most relevant data for their models.
Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ dev = [
"types-PyYAML",
"opencv-python",
"types-tqdm>=4.67.0.20241221",
"mkdocs==1.6.1",
"mkdocs-material==9.7.6",
"mkdocs-git-revision-date-localized-plugin==1.4.7",
]

[build-system]
Expand All @@ -71,6 +74,7 @@ pythonpath = [
]

[tool.isort]

profile = "black"

[tool.mypy]
Expand Down
Loading
Loading