.. Brawl Wiki documentation master file, created by
   sphinx-quickstart on Sat Jan 25 19:17:13 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Brawl Wiki's documentation!
======================================

- This library is a sync wrapper for https://ariusx7.github.io/brawlwiki-api/ (BrawlWiki API).
- Python 3.6 or later is required.

Features
~~~~~~~~

- Covers all of the endpoints of the API.
- Access constant values such as attack name, description, etc!
- Easy to use with an object oriented design.

.. toctree::
   :maxdepth: 3

   api
   exceptions

Indices
=======

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