.. BugDoc documentation master file, created by
   sphinx-quickstart on Tue Mar 16 18:11:01 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to BugDoc's documentation!
==================================

`BugDoc` is a framework for finding root causes of errors in computational pipelines.
For more detailed information about the framework, please refer to our SIGMOD paper:

`BugDoc: Algorithms to Debug Computational Processes. Raoni Lourenço, Juliana Freire, and Dennis Shasha. In ACM SIGMOD, 2020. <https://arxiv.org/abs/2004.06530>`_

You can find the source code on GitHub: https://github.com/VIDA-NYU/BugDoc

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   definitions
   getting-started
   api
   auto_examples/index
   client


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

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