=====================
Lamassu documentation
=====================


Getting help
============

Having trouble? We'd like to help!

* Try the :doc:`FAQ <faq>` -- it's got answers to some common questions.
* Looking for specific information? Try the :ref:`genindex` or :ref:`modindex`.
* Report bugs with lamassu in our `issue tracker`_.
* Join the Discord community `Lamassu Discord`_.

.. hint::
    * Since methods with two underscores (`__`) cannot be tested due to the
      `name mangling <https://qubitpi.github.io/cpython/tutorial/classes.html#private-variables>`_. Lamassu requires
      all private methods and attributes to be prefixed with **single underscore prefix (`_`) only**
    * The phrase "Chinese" used throughout this documentation referse to "**Simplified Chinese**", instead of
      "Traditional Chinese"


First Steps
===========

.. toctree::
   :caption: First steps
   :hidden:

   intro/install

:doc:`intro/install`
    Get lamassu installed on your computer.


Usage
=====

.. toctree::
   :maxdepth: 100

   lamassu

.. _issue tracker: https://github.com/QubitPi/lamassu/issues
.. _Lamassu Discord: https://discord.com/widget?id=1208960229002317934&theme=dark