.. CroissantBot documentation master file, created by
   sphinx-quickstart on Sun Oct  3 01:13:24 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to CroissantBot's documentation!
========================================

CroissantBot's documentation is organized as follows:

.. toctree::
   :maxdepth: 1
   :caption: Getting started

   getting_started/intro
   getting_started/commands
   getting_started/bot
   getting_started/additional-info

.. toctree::
   :maxdepth: 1
   :caption: Cogs

   cogs/intro-cogs
   cogs/favourites
   cogs/meme
   cogs/misc
   cogs/music
   cogs/playlist
   cogs/twitch
   cogs/youtube

.. toctree::
   :maxdepth: 1
   :caption: ext modules

   ext/ext-modules
   ext/db
   ext/music_db
   ext/songqueue
   ext/song

.. toctree::
   :maxdepth: 1
   :caption: Other documents

   other/CONTRIBUTING
   other/LICENSE
   other/upgrading

Origin
------

I couldn't find the original video, but this meme is the inspiration for
the name and :ref:`croissant <croissant-command>` command: `<https://www.youtube.com/watch?v=s8VJ4QuVDBE>`_.

License
-------

This project is available under the MIT license.
See the :doc:`other/LICENSE` file for more info.

Contributing
------------

All contributions are welcome, see :doc:`other/CONTRIBUTING`.

Versioning
----------

The versions of the bot's repo follow the rules of `Semantic Versioning 2.0.0 <https://semver.org/>`__.

Source code
-----------

The source code and documentation are hosted on Github:
https://github.com/JulioLoayzaM/CroissantBot.

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

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