Jirka Borovec
2abdccbe1d
docs: Wrap all placeholder paths in quotes and code expressions ( #2128 )
...
* Wrap all placeholder paths in quotes across documentation and code examples for consistency
* Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 14:00:40 +01:00
Jirka Borovec
6149bacc77
Fix and augment relative links in MD files to GitHub blob URLs ( #2061 )
...
* Add script to augment relative links in MD files to GitHub blob URLs
* fix(pre_commit): 🎨 auto format pre-commit hooks
* Add type annotations to `augment_links.py` and update config
* Add `lychee-action` for link checking in CI workflows
* Apply suggestions from code review
* links in README.md
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-02 17:47:59 +01:00
Onuralp SEZER
5d883447a3
docs: 📝 update Python version requirement to 3.9 in docs and clean up code
2025-07-14 20:21:35 +03:00
James
89ca7226b9
Merge branch 'develop' into new-theme
2025-06-18 17:20:33 -04:00
James
4255e63269
work on new theme
2025-06-17 09:34:23 -04:00
Onuralp SEZER
16848e9160
docs: 📝 update installation instructions to replace Poetry with uv in index.md
2025-01-09 00:30:45 +03:00
Onuralp SEZER
228b4cff0c
docs: 📝 extend supervision installation methods
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-11-29 20:59:32 +03:00
Onuralp SEZER
a57f4f22ae
docs: 📝 git clone examples with single branch and single depth added into example docs
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-11-19 17:59:58 +03:00
Onuralp SEZER
78f17cba2e
chore: 🧹 clean up documentation and improve formatting
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-09-27 14:18:26 +03:00
LinasKo
7de1f5855d
Merge branch 'develop' into feat/f1-metric
2024-09-20 19:06:39 +03:00
LinasKo
7f85963314
Add F1 to docs, rewrite the docstrings
2024-09-20 14:50:46 +03:00
Onuralp SEZER
c9fa3d613f
Merge branch 'develop' into feature/pip-package-configuration
2024-09-19 17:47:28 +03:00
Onuralp SEZER
4644f21340
docs: 📝 documentation adjusment for installations
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-09-19 17:42:37 +03:00
LinasKo
95add3679d
Fix broken or outdated links
...
* Not exhaustive.
2024-09-18 19:06:41 +03:00
LinasKo
57ae7467b9
Add cheatsheet links in supervision docs, readme
2024-07-08 13:57:12 +03:00
pre-commit-ci[bot]
719af725b1
fix(pre_commit): 🎨 auto format pre-commit hooks
2024-03-28 17:53:57 +00:00
SkalskiP
e88ab7c125
small update
2024-03-28 18:53:39 +01:00
Onuralp SEZER
f9fd88fb01
docs: 📚 conda and mamba installation methods added
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-03-28 18:00:43 +03:00
pre-commit-ci[bot]
cf88cc0384
fix(pre_commit): 🎨 auto format pre-commit hooks
2024-03-25 20:14:17 +00:00
SkalskiP
15e17adef1
Detect Small Objects documentation
2024-03-25 21:11:47 +01:00
Onuralp SEZER
0d312f3cd7
docs: 📝 h1 title Home removed from index.md
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-09 20:17:53 +03:00
Onuralp SEZER
4e5331b92d
docs(version): 🐞 restore version part and revert hide h1 on home for now
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-08 18:57:39 +03:00
Onuralp SEZER
d900e68787
docs(home): 🚀 hide table of content for home page only and give looks as more like home of supervision
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-08 17:33:52 +03:00
Onuralp SEZER
d2ccc4f270
docs(nav): 🚀 nav-tab enabled and new order of pages for better understanding
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-08 17:13:03 +03:00
Onuralp SEZER
71a18a12d7
docs: 📝 install and quick start position swapped
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 22:17:25 +03:00
SkalskiP
c6718d374c
update docs
2024-01-31 08:28:34 +01:00
SkalskiP
6565fae1c2
final docs updates
2024-01-24 17:47:11 +01:00
SkalskiP
79560945f5
ready for merge
2024-01-24 15:07:32 +01:00
SkalskiP
99d1b6d130
ready for review
2024-01-17 12:11:31 +01:00
Onuralp SEZER
4079188368
Merge branch 'develop' into py12-upgrade
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2023-12-08 00:09:48 +03:00
Onuralp SEZER
e42770eedb
feat(py-version): ✨ Python 3.12 support added
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2023-12-07 19:54:52 +03:00
Onuralp SEZER
4baf570b28
docs(fix): 📓 poetry env typo fix
2023-10-14 01:12:16 +03:00
Onuralp SEZER
a14159c150
docs: 📓 development virtualenv installation pip upgrade added
2023-10-13 00:56:01 +03:00
Onuralp SEZER
b1325132d7
fix(docs): 🐛 doc formatting fix and exclude docs from black formatting
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2023-08-07 23:49:44 +03:00
Onuralp SEZER
57e17c34a0
feat: 🚀 pre-commit and initial formatted files
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2023-07-25 13:02:26 +03:00
Onuralp SEZER
effa1415b5
docs: 📝 Update python version for supervision version 0.12.0
...
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2023-07-22 16:14:03 +03:00
SkalskiP
f1f2728e0d
📝 updated install guide
2023-07-21 23:11:03 +02:00
SkalskiP
14f62deacf
📚 `ImageSink` documentation updated
2023-06-06 20:13:33 +02:00
James Gallagher
90a26747b6
create stub doc files, refactor docstrings, add placeholders for examples
2023-02-01 10:28:49 +00:00
SkalskiP
1561bd0027
🎬 poc of video utils documentation
2023-01-31 09:36:39 +01:00
SkalskiP
02c20e81a9
📚 initial documentation commit
2023-01-30 19:50:25 +01:00