.. AF Analysis documentation master file, created by
   sphinx-quickstart on Mon Nov 20 13:03:43 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


Welcome to AlphaFold Analysis's documentation!
==============================================

.. image:: https://raw.githubusercontent.com/samuelmurail/af_analysis/master/docs/source/logo.jpeg
  :width: 300
  :align: center
  :alt: AF Analysis Logo

``af_analysis`` is a python library designed to facilitate analysis of AlphaFold results.


.. toctree::
   :maxdepth: 4
   :caption: Getting Started

   readme
   installation

.. toctree::
   :maxdepth: 4
   :caption: User Guide

   analysis
   notebooks/basic_example.ipynb
   af_analysis_gui

.. toctree::
   :maxdepth: 4
   :caption: Development

   contributing
   Github Repository <https://github.com/samuelmurail/af_analysis>

.. toctree::
   :maxdepth: 4
   :caption: API Reference

   modules

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

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