Skip to content

Commit 18e3f3c

Browse files
committed
Add docs to frontpage
1 parent 11c7c5f commit 18e3f3c

File tree

2 files changed

+9
-15
lines changed

2 files changed

+9
-15
lines changed

docs/index.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,22 @@ bbox-visualizer:
55

66
bbox-visualizer helps you easily draw bounding boxes with their corresponding labels after detecting them using any object detection method. The bounding boxes are expected to be in the format :python:`(xmin, ymin, xmax, ymax)`.
77

8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
installation
14+
815
Usage
916
-----
1017
.. code-block:: python
1118
1219
import bbox_visualizer as bbv
1320
14-
.. toctree::
15-
:maxdepth: 2
16-
:caption: Contents:
21+
.. automodule:: bbox_visualizer.bbox_visualizer
22+
:members:
1723

18-
installation
19-
modules
2024

2125

2226
Project Info

docs/modules.rst

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

0 commit comments

Comments
 (0)