Welcome to FeatMF's documentation!
====================================

**Feature Matching Framework**: A python package for local features.

.. warning::
    This package is still in (pre-alpha) development. The API may change in the future. Currently, there is no backward guarantee and the project stands unreleased (no release path as of now).

.. contents:: Table of contents
    :depth: 3

Python API
-----------

The Python API documentation can be found `here <api>`_.

Acknowledgements
-----------------

This project is developed by TheProjectsGuy (Avneesh Mishra). Some help (in form of code and documentation) is provided by GitHub Copilot and Bing AI (Microsoft).

Indices and tables
--------------------

.. toctree::
    :maxdepth: 3
    :caption: Contents
    :hidden:
    
    api/index
    developer

.. toctree::
    :maxdepth: 1
    :caption: Indices
    :hidden:
    
    modindex
    genindex

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. image:: https://img.shields.io/badge/Developer-TheProjectsGuy-blue
    :target: https://github.com/TheProjectsGuy
