shortenit/docs/index.rst
Elia el Lazkani 6542ad3a8c chore(): Adds Sphinx to the mix
* Adds Sphinx to the dependency list
* Generates Sphinx related configuration
* Created Sphinx related docs
2024-11-30 11:50:55 +01:00

34 lines
628 B
ReStructuredText

.. shortenit documentation master file, created by
sphinx-quickstart on Sat Nov 30 11:26:49 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Shortenit Documentation
=======================
``Shortenit`` is a tool to shorten urls.
**NOTE**: This is a very early draft project. Contributions are welcome.
.. toctree::
:maxdepth: 1
:caption: Contents:
common
config
data
db
exceptions
logger
main
pointer
shortener
web
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`