.. Filament documentation master file, created by
   sphinx-quickstart on Sun May 10 19:43:22 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive. REMEMBER TO FIX BADGES

.. |b1| image:: https://img.shields.io/badge/code%20style-black-000000.svg
.. |b2| image:: https://img.shields.io/pypi/v/lightbulb-ext-filament.svg
.. |b3| image:: https://img.shields.io/pypi/pyversions/lightbulb-ext-filament
.. |b5| image:: https://img.shields.io/readthedocs/filament
.. |b6| image:: https://img.shields.io/badge/license-LGPL--3.0-brightgreen
.. |b7| image:: https://img.shields.io/github/stars/tandemdude/lightbulb-ext-filament
.. |b8| image:: https://img.shields.io/github/forks/tandemdude/lightbulb-ext-filament
.. |b9| image:: https://img.shields.io/pypi/status/lightbulb-ext-filament

Filament
========

|b1|

|b2| |b3| |b7| |b8|

|b5| |b6| |b9|

----

Various add-ons, extensions and utilities for `hikari-lightbulb <https://github.com/tandemdude/hikari-lightbulb/>`_

Installation
------------

Use the package manager `pip <https://pip.pypa.io/en/stable/>`_ to install Filament.

.. code-block:: bash

   pip install lightbulb-ext-filament

Issues
------

If you find any bugs, issues, or unexpected behaviour while using the library,
you should open an issue with details of the problem and how to reproduce if possible.
Please also open an issue for any new features you would like to see added.

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

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please try to ensure that documentation is updated if you add any features accessible through the public API.

If you use this library and like it, feel free to sign up to GitHub and star the project,
it is greatly appreciated and lets me know that I'm going in the right direction!

Links
-----

**Repository:** `GitHub <https://github.com/tandemdude/filament>`_

**Documentation:** `View Here <https://filament.readthedocs.io/en/latest/>`_

**Index:**

.. toctree::
   :maxdepth: 2

   templating
   extensions
   general-api-reference
   utils-api-reference

* :ref:`genindex`