Update docs

Author: shoumikchow

.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs 

docs/api.rst

@@ -0,0 +1,7 @@
+API Reference
+============
+
+.. automodule:: bbox_visualizer.bbox_visualizer
+   :members:
+   :undoc-members:
+   :show-inheritance: 

docs/conf.py

@@ -31,7 +31,14 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'recommonmark', 'sphinx.ext.autosectionlabel', 'sphinx.ext.napoleon']
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    'sphinx_autodoc_typehints',
+    'myst_parser',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -47,8 +54,8 @@
 
 # General information about the project.
 project = 'bbox-visualizer'
-copyright = "2020, Shoumik Sharar Chowdhury"
-author = "Shoumik Sharar Chowdhury"
+copyright = '2024, Shoumik Sharar Chowdhury'
+author = 'Shoumik Sharar Chowdhury'
 
 # The version info for the project you're documenting, acts as replacement
 # for |version| and |release|, also used in various other places throughout
@@ -64,7 +71,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -94,7 +101,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ['_static']
 
 #
 autosectionlabel_prefix_document = True
@@ -161,5 +168,14 @@
      'Miscellaneous'),
 ]
 
+# Auto-generate API documentation
+autodoc_default_options = {
+    'members': True,
+    'member-order': 'bysource',
+    'special-members': '__init__',
+    'undoc-members': True,
+    'exclude-members': '__weakref__'
+}
+
 
 

docs/index.rst

@@ -1,36 +1,19 @@
-bbox-visualizer:
-================
-.. role:: python(code)
-   :language: python
-
-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)`.
+Welcome to bbox-visualizer's documentation!
+=====================================
 
+bbox-visualizer is a Python package that provides different ways to visualize objects given bounding box data.
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+   readme
    installation
-
-Usage
------
-.. code-block:: python
-
-   import bbox_visualizer as bbv
-
-.. automodule:: bbox_visualizer.bbox_visualizer
-    :members:
-
-
-Project Info
-------------
-
-.. toctree::
-   :maxdepth: 2
-   
-   ../CONTRIBUTING
-   ../HISTORY
-   ../AUTHORS
+   usage
+   api
+   contributing
+   authors
+   history
 
 Indices and tables
 ==================

docs/installation.rst

@@ -4,19 +4,10 @@
 Installation
 ============
 
-Requirements
------------
-
-* Python >= 3.8
-* opencv-python >= 4.1.0.25
-* numpy >= 1.19.0
-
-bbox-visualizer officially supports Python 3.8, 3.9, 3.10, 3.11, and 3.12.
-
 Recommended Installation (using uv)
 --------------------------------
 
-`uv` is a extremely fast Python package installer and resolver. To install bbox-visualizer using uv:
+`uv` is an extremely fast Python package installer and resolver. To install bbox-visualizer using uv:
 
 1. First, install uv if you haven't already:
 
@@ -39,49 +30,34 @@ You can also install bbox-visualizer using pip:
 
     $ pip install bbox-visualizer
 
-If you don't have `pip`_ installed, this `Python installation guide`_ can guide
-you through the process.
-
-.. _pip: https://pip.pypa.io
-.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
-
-
-From sources
-------------
+From Source
+----------
 
-The sources for bbox_visualizer can be downloaded from the `Github repo`_.
+The source for bbox-visualizer can be downloaded from the `Github repo`_.
 
-You can either clone the public repository:
+You can clone the public repository:
 
 .. code-block:: console
 
     $ git clone git://github.com/shoumikchow/bbox-visualizer
 
-Or download the `tarball`_:
+Once you have a copy of the source, you can install it with uv (recommended):
 
 .. code-block:: console
 
-    $ curl -OJL https://github.com/shoumikchow/bbox-visualizer/tarball/master
-
-Once you have a copy of the source, you can install it using uv (recommended):
-
-.. code-block:: console
-
-    $ uv pip install .
+    $ uv pip install -e .
 
 For development installation with all extra dependencies:
 
 .. code-block:: console
 
-    $ uv pip install ".[dev]"
+    $ uv pip install -e ".[dev]"
 
 Or using pip:
 
 .. code-block:: console
 
-    $ pip install .
-    $ pip install ".[dev]"  # for development installation
-
+    $ pip install -e .
+    $ pip install -e ".[dev]"  # for development installation
 
 .. _Github repo: https://github.com/shoumikchow/bbox-visualizer
-.. _tarball: https://github.com/shoumikchow/bbox-visualizer/tarball/master

docs/usage.rst

@@ -0,0 +1,35 @@
+Usage
+=====
+
+To use bbox-visualizer in a project:
+
+.. code-block:: python
+
+    import bbox_visualizer as bbv
+    import cv2
+    import numpy as np
+
+    # Load an image
+    image = cv2.imread('image.jpg')
+
+    # Example bounding box in (xmin, ymin, xmax, ymax) format
+    bbox = (100, 100, 200, 200)
+    label = "Object"
+
+    # Draw bounding box with label
+    image_with_box = bbv.draw_rectangle(image, bbox)
+    image_with_label = bbv.add_label(image_with_box, label, bbox)
+
+    # Or use multiple bounding boxes
+    bboxes = [(100, 100, 200, 200), (300, 300, 400, 400)]
+    labels = ["Object 1", "Object 2"]
+
+    # Draw multiple boxes with labels
+    for bbox, label in zip(bboxes, labels):
+        image = bbv.draw_rectangle(image, bbox)
+        image = bbv.add_label(image, label, bbox)
+
+    # Display the result
+    cv2.imshow('Image with bounding boxes', image)
+    cv2.waitKey(0)
+    cv2.destroyAllWindows() 

pyproject.toml

@@ -41,7 +41,14 @@ dev = [
     "pytest-cov>=6.0.0",
     "black>=24.1.1",
     "ruff>=0.2.1",
-    "Sphinx>=7.0.0",
+]
+
+docs = [
+    "sphinx>=7.0.0",
+    "sphinx-rtd-theme>=2.0.0",
+    "sphinx-autodoc-typehints>=1.24.0",
+    "myst-parser>=2.0.0",
+    "docutils>=0.20.1"
 ]
 
 [project.urls]