Skip to content

Commit 19243ae

Browse files
committed
Fix documentation
1 parent d0faccf commit 19243ae

File tree

3 files changed

+41
-5
lines changed

3 files changed

+41
-5
lines changed

docs/api.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Rectangle Drawing
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
14+
:no-index:
1415

1516
Label Drawing
1617
~~~~~~~~~~~
@@ -19,11 +20,13 @@ Label Drawing
1920
:members:
2021
:undoc-members:
2122
:show-inheritance:
23+
:no-index:
2224

2325
Special Labels
2426
~~~~~~~~~~~~
2527

2628
.. automodule:: bbox_visualizer.core.flags
2729
:members:
2830
:undoc-members:
29-
:show-inheritance:
31+
:show-inheritance:
32+
:no-index:

docs/bbox_visualizer.core.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
bbox\_visualizer.core package
2+
=============================
3+
4+
Submodules
5+
----------
6+
7+
bbox\_visualizer.core.flags module
8+
----------------------------------
9+
10+
.. automodule:: bbox_visualizer.core.flags
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
bbox\_visualizer.core.labels module
16+
-----------------------------------
17+
18+
.. automodule:: bbox_visualizer.core.labels
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
bbox\_visualizer.core.rectangle module
24+
--------------------------------------
25+
26+
.. automodule:: bbox_visualizer.core.rectangle
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: bbox_visualizer.core
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:

docs/index.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,9 @@ The package is organized into several modules for different visualization needs:
1212
:maxdepth: 2
1313
:caption: Contents:
1414

15-
readme
1615
installation
1716
usage
1817
api
19-
contributing
20-
authors
21-
history
2218

2319
Indices and tables
2420
==================

0 commit comments

Comments
 (0)