Skip to content
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

Jump to bottom

docs(page): 🚀 Supervision Cookbook #860

Merged
merged 17 commits into from
Feb 8, 2024
Merged

docs(page): 🚀 Supervision Cookbook #860

merged 17 commits into from
Feb 8, 2024

Conversation

onuralpszr
Copy link
Collaborator

Description

Introduce new page to Supervision Documentation

Please delete options that are not relevant.

  • This change requires a documentation update

How has this change been tested, please provide a testcase or example of how you tested the change?

Make sure virtualenv is python3.10 or above and install package

pip install jupyterlab mkdocs-jupyter "mkdocs-material[all]" "mkdocstrings[python]" mkdocs-git-committers-plugin-2 mkdocs-git-revision-date-localized-plugin
mkdocs serve

Docs

  • Docs updated? What were the changes:
  1. New cookbook page landed
  2. Author names /page last update and create date are added
  3. Notebook generator added

@onuralpszr
docs: ✨ jupyter notebook support added
a6d9961 
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr onuralpszr added documentation Improvements or additions to documentation enhancement New feature or request doc:sv:notebooks Supervision Notebook Related Updates labels Feb 8, 2024
@onuralpszr onuralpszr added this to the version: 0.19.0 milestone Feb 8, 2024
@onuralpszr onuralpszr self-assigned this Feb 8, 2024
@onuralpszr
docs: ✨ supervision cookbook initial page design landed
6ffd159 
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr
docs: ✨ folder rename to javascript to javascripts (plural)
1fba192 
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr onuralpszr changed the title feat: 🚀 Supervision Cookbook docs(page): 🚀 Supervision Cookbook Feb 8, 2024
onuralpszr and others added 10 commits February 8, 2024 15:31
@onuralpszr
Merge changes from develop branch
c436587
@onuralpszr
docs: ✨ add demo notebook and remove notebooks folder from ignore list
1a20bb5 
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr
docs: ✨ data-url param added
3ddeed1 
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr
docs(js): 🔥 unused params has been removed from js files for cookbook…
15b4914 
… page

Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr
docs(nav): 🚀 nav-tab enabled and new order of pages for better unders…
d2ccc4f 
…tanding

Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@pre-commit-ci
fix(pre_commit): 🎨 auto format pre-commit hooks
1ad26b5
@onuralpszr
docs(nb): 🚀 initial notebook added as quickstart and other examples a…
ab38cb1 
…re removed

Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr
docs(home): 🚀 hide table of content for home page only and give looks…
d900e68 
… as more like home of supervision

Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@pre-commit-ci
fix(pre_commit): 🎨 auto format pre-commit hooks
f81ccbc
@onuralpszr
ci(docs): 👷 new packages added for build document
4ef2d04 
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr
ci(docs): 👷 GH_TOKEN added for git-committers
6a091b5 
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr
docs(assets): 🐞 missing js and css files added into mkdocs.yml
985624e 
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr
docs(version): 🐞 restore version part and revert hide h1 on home for now
4e5331b 
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr
docs(api): 📝 api/annotators position adjusted and small typo fix
08a204d 
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@SkalskiP SkalskiP merged commit 82b18ae into develop Feb 8, 2024
8 checks passed
@SkalskiP SkalskiP mentioned this pull request Mar 13, 2024
Merged
@onuralpszr onuralpszr deleted the docs/notebooks branch September 23, 2024 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SkalskiP SkalskiP SkalskiP approved these changes

Assignees

@onuralpszr onuralpszr

Labels
doc:sv:notebooks Supervision Notebook Related Updates documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
version: 0.19.0
Development

Successfully merging this pull request may close these issues.
2 participants
@onuralpszr @SkalskiP