.. rojak documentation master file, created by
   sphinx-quickstart on Mon Jun  2 09:14:34 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

rojak documentation
===================

``rojak`` is an open source library and CLI tool for analysing aviation turbulence.

.. toctree::
   :maxdepth: 2
   :hidden:

   userguide/index
   api/index

.. grid:: 1 1 2 2
    :gutter: 2

    .. grid-item-card::  Installation Guide
        :img-top: _static/index_installation.svg
        :class-card: intro-card
        :link: userguide/installguide
        :link-type: doc

        *Ready to Get Started??*

        Visit our installation guide!

    .. grid-item-card::  User guide
        :img-top: _static/index_user_guide.svg
        :class-card: intro-card
        :link: userguide/index
        :link-type: doc

        Visit the user guide to learn more about how to use rojak

    .. grid-item-card::  API reference
        :img-top: _static/index_api.svg
        :class-card: intro-card
        :link: api/index
        :link-type: doc

        *Want to get into the nitty gritty?*

        Dive into rojak's API documentation