Documentação do pacote tabatu
=============================

O pacote tabatu oferece uma API para obter de forma simples quantidades relevantes sobre tábuas atuárias, isto é,
tábuas biométricas, taxas de juros, comutações e fluxos.

Instalação
----------

Para usar o pacote, é necessário realizar a instalação via pip:

.. code-block:: console

   # pip install -e .


.. grid:: 2
    :gutter: 4
    :padding: 2 2 0 0
    :class-container: sd-text-center

    .. grid-item-card::  User guide
        :img-top: _static/index_user_guide.svg
        :class-card: intro-card
        :shadow: md

        O guia de usuário fornece informações detalhadas sobre como usar o tabatu. Estão incluídos exemplos
        das diversas funcionalidades do pacote, assim como explicações de pontos teóricos importantes.

        +++

        .. button-ref:: user_guide
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            Para o guia de usuário

    .. grid-item-card::  API reference
        :img-top: _static/index_api.svg
        :class-card: intro-card
        :shadow: md

        A referênciad a API apresenta descrições detalhadas da API do tabatu. Mostra como os métodos
        e classes são usados e quais argumentos são necessários.

        +++

        .. button-ref:: api_ref
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            Para a referência de API


.. toctree::
    :maxdepth: 3
    :hidden:
    :titlesonly:


    user/index
    reference/index