.. cgeniepy documentation master file, created by
   sphinx-quickstart on Sun Feb  4 00:03:58 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

   
Get started
------------
.. grid:: 1 1 2 2
    :gutter: 2

    .. grid-item-card:: About this package
        :link: about
        :link-type: doc

	This sections introduces this package and my motivation to create it.
		    
    .. grid-item-card::  Installation
        :link: installation
        :link-type: doc

        First time to use Python? The user guide gives you a simple introduction of it and 
        a instruction of how to install this package.

    .. grid-item-card::  User guide
        :link: guide
        :link-type: doc

        This section gives a complete user guide with more technical details.

    .. grid-item-card::  Examples
       :link: auto_examples/index
       :link-type: doc

       In this section, I provide some existing codes and related output for you to directly use and modify according to your own output.


.. toctree::
   :hidden:
   :maxdepth: 1	      
 
   about

.. toctree::
   :hidden:
   :maxdepth: 1	      
 
   installation
   
.. toctree::
   :hidden:
   :maxdepth: 1	      

   guide
   
.. toctree::
   :hidden:
   :maxdepth: 1	      
 
   auto_examples/index

..
   to be done: API   
   .. toctree::
      :hidden:
      :maxdepth: 1	      

      auto_examples/index