.. metrify documentation master file, created by
   sphinx-quickstart on Mon May 13 18:12:38 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to metrify's documentation!
===================================

Overview
--------
`metrify <https://github.com/open-metrify/metrify>`_ é uma aplicação 
desenvolvida para scrum masters e equipes ágeis com o propósito automatizar a 
coleta e processamento de métricas relacionadas ao progresso de sprints e o 
cálculo e estimativa de rendimento com base em análise estatística do histórico 
de dados através do consumo da API do *Github*.

.. note::
   Este projeto está em fase de desenvolvimento ativo.

:doc:`installation`
  Instruções sobre instalação e execução.

:doc:`impl/index`
  Documentação compreensiva do código de implementação, organizado por módulo.

:doc:`api`
  Documentação das rotas de API acessíveis.

.. toctree::
   :hidden:

   installation
   impl/index
   api



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

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