.. Search-a-licious documentation master file, created by
   sphinx-quickstart on Tue Jul 16 09:14:56 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Search-a-licious code documentation
===================================

This documents the backend code of search-alicious.

For `general documentation about search-a-licious Follow this link`__

.. note: this only work on github pages
.. __: /search-a-licious

The backend is built using FastAPI_ and a lot of tiangolo_ packages

.. _FastAPI: https://fastapi.tiangolo.com/
.. _tiangolo: https://tiangolo.com/projects/

Here is the documentation of main modules, by topics:

.. toctree::
   :maxdepth: 2

   api
   config
   cli
   searching
   types
   misc

Indices and tables
==================

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