.. include:: readme.rst

.. toctree::
  :caption: User documentation
  :maxdepth: 2

  Home <self>
  From Python <doc-python>

.. toctree::
  :caption: Notebook examples
  :maxdepth: 2

  FE <notebooks/fe_example>
  CRE <notebooks/cre_example>
  BLM <notebooks/blm_example>
  Sorkin <notebooks/sorkin_example>
  Borovickova-Shimer <notebooks/borovickovashimer_example>
  Attrition <notebooks/attrition_example>
  CHK Event Study <notebooks/chk_example>
  Monte Carlo <notebooks/monte_carlo_example>

.. toctree::
  :caption: Under the hood
  :maxdepth: 2

  internal
  FEEstimator <class-feestimator>
  FEControlEstimator <class-fecontrolestimator>
  CREEstimator <class-creestimator>
  Attrition <class-attrition>
  BLMModel <class-blmmodel>
  BLMEstimator <class-blmestimator>
  BLMBootstrap <class-blmbootstrap>
  BLMVarianceDecomposition <class-blmvariancedecomposition>
  InteractedBLMModel <class-interactedblmmodel>
  SorkinEstimator <class-sorkinestimator>
  BSEstimator <class-bsestimator>
  MonteCarlo <class-montecarlo>
  Q <module-Q>
  Constraints <module-constraints>
  Attrition Utilities <module-attrition_utils>
  Diagnostics <module-diagnostics>