.. pairk documentation master file, created by
   sphinx-quickstart on Thu Mar 15 13:55:56 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
   .. :maxdepth: 2
   .. :hidden:
   .. :titlesonly:

=========================================================
Welcome to pairk's documentation!
=========================================================

repository link - https://github.com/jacksonh1/pairk


.. grid:: 1 1 5 1

    .. grid-item-card:: Getting Started
      :margin: 0 3 0 0
      
      quick pairk startup guide

      .. button-link:: ./getting_started.html
         :color: primary
         :outline:
         :expand:

         To the Getting Started Guide

      

    .. grid-item-card::  PairK Tutorial
      :margin: 0 3 0 0
      
      An in-depth guide for users.

      .. button-link:: ./pairk_tutorial_simplified.html
         :color: primary
         :outline:
         :expand:

         To the PairK Tutorial
      
      
    .. grid-item-card::  Examples
      :margin: 0 3 0 0
      
      Examples using pairk and how to interpret the results

      .. button-link:: ./notebooks/pairk_examples.html
         :color: primary
         :outline:
         :expand:

         To the Examples
      

    .. grid-item-card:: API Reference
      :margin: 0 3 0 0
      
      PairK API. The docstrings of the main functions

      .. button-link:: ./api.html
         :color: primary
         :outline:
         :expand:

         To the API Reference.



    .. grid-item-card:: References
      :margin: 0 3 0 0
      
      references and acknowledgements

      .. button-link:: ./references.html
         :color: primary
         :outline:
         :expand:

         To the References
      


.. toctree::
   :maxdepth: 2

   getting_started
   notebooks_rst/pairk_tutorial_simplified.rst
   notebooks/pairk_examples
   k_mer_alignment
   api
   references


.. user_guide