Skip to content

Add a documentation tab menu for Python API examples #753

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.

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

Merged
merged 2 commits into from
Nov 1, 2022
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
(<https://github.com/openvinotoolkit/datumaro/pull/744>)
- Add Label, Points, Polygon, PolyLine, and Caption visualization features
(<https://github.com/openvinotoolkit/datumaro/pull/746>)
- Add a documentation tab menu for Python API
(<https://github.com/openvinotoolkit/datumaro/pull/753>)

### Changed
- Updated `networkx` version to 2.6
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ CVAT annotations ---> Publication, statistics etc.
- [Features](#features)
- [User manual](https://openvinotoolkit.github.io/datumaro/docs/user-manual)
- [Developer manual](https://openvinotoolkit.github.io/datumaro/api)
- [Python API](https://openvinotoolkit.github.io/datumaro/docs/python-api)
- [Contributing](#contributing)

## Features
Expand Down
17 changes: 17 additions & 0 deletions site/content/en/docs/python-api/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Python API'
linkTitle: 'Python API'
description: ''
weight: 3
---

## What is Python API
Need to update the description.

## Contents
- [Python API examples](./python-api-examples)
- [Visualizer](./python-api-examples/visualizer)
- [Filter](./python-api-examples/filter)
- [Transform](./python-api-examples/transform)
- [Generate](./python-api-examples/generate)
- [Validate](./python-api-examples/validate)
9 changes: 9 additions & 0 deletions site/content/en/docs/python-api/python-api-examples/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: 'Python API examples'
linkTitle: 'Python API examples'
description: ''
weight: 6
---

### How to use Python API
Need to update the description.
10 changes: 10 additions & 0 deletions site/content/en/docs/python-api/python-api-examples/filter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Filter'
linkTitle: 'filter'
description: ''
---

Need to update the description.

Jupyter Notebook Examples:
Need to update the description.
10 changes: 10 additions & 0 deletions site/content/en/docs/python-api/python-api-examples/generate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Generate'
linkTitle: 'generate'
description: ''
---

Need to update the description.

Jupyter Notebook Examples:
Need to update the description.
10 changes: 10 additions & 0 deletions site/content/en/docs/python-api/python-api-examples/transform.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Transform'
linkTitle: 'transform'
description: ''
---

Need to update the description.

Jupyter Notebook Examples:
Need to update the description.
10 changes: 10 additions & 0 deletions site/content/en/docs/python-api/python-api-examples/validate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Validate'
linkTitle: 'validate'
description: ''
---

Need to update the description.

Jupyter Notebook Examples:
Need to update the description.
10 changes: 10 additions & 0 deletions site/content/en/docs/python-api/python-api-examples/visualizer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Visualizer'
linkTitle: 'visualizer'
description: ''
---

Need to update the description.

Jupyter Notebook Examples:
Need to update the description.