Skip to content

Commit 4fc3cce

Browse files
authored
Remove redundant example notebook (#13)
* removed old example * add intersphinx mapping to Python
1 parent 9ebb928 commit 4fc3cce

File tree

3 files changed

+14
-45
lines changed

3 files changed

+14
-45
lines changed

docs/source/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,8 @@
122122
# relative to this directory. They are copied after the builtin static files,
123123
# so a file named "default.css" will overwrite the builtin "default.css".
124124
# html_static_path = ['_static']
125+
126+
127+
intersphinx_mapping = {
128+
"python": ("https://docs.python.org/3", None),
129+
}

examples/notebook_annotations_to_coco.py

Lines changed: 0 additions & 45 deletions
This file was deleted.

poseinterface/io.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,15 @@ def annotations_to_coco(
5454
The format of the input annotations file is automatically inferred based
5555
on its extension. See :func:`sleap_io.io.main.load_file` for supported
5656
formats.
57+
58+
Example
59+
-------
60+
>>> from pathlib import Path
61+
>>> from poseinterface.io import annotations_to_coco
62+
>>> coco_json_path = annotations_to_coco(
63+
... input_path=Path("path/to/annotations.slp"),
64+
... output_json_path=Path("path/to/annotations_coco.json"),
65+
... )
5766
"""
5867
labels = sio.load_file(input_path)
5968
# Check if labels object is empty

0 commit comments

Comments
 (0)