.. RichSuiteDocs documentation master file, created by
   sphinx-quickstart on Fri Apr 30 17:59:37 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to RichSuiteDocs's documentation!
=========================================

.. toctree::
   Welcome
   Installation
   :maxdepth: 1
   :caption: Introduction:

.. toctree::
   Tutorials/FieldLinesTutorial
   Tutorials/ADMTutorial
   :maxdepth: 1
   :caption: Tutorials:

.. toctree::
   Users/field/Build_pot_field
   Users/ADM/Build_adm_vol
   Users/rad/rad
   :maxdepth: 1
   :caption: Users' Manuals:


.. toctree::
   Manuals/FortDocGenerator
   Manuals/PythonTools
   Manuals/MainCode/index
   :caption: Developers' Manuals


testing format here
=========================================


.. class:: astro_star

    .. method:: star_t_ (omega) result (st)
    
           Testing the docstrings
           Another line of doc string
           Here's the more complete description
           that continues on another line
           
    .. method:: Phi_eff_ (this, vr) result (Phi_eff)
    
           Calculate the effective potential (units: G M_star/R_pole) at vr
           (units: R_pole)
           
           :param this: a star_t object
           :param vr:   a position
           :rtype Phi_eff: the potential as position vr
           
    .. method:: vg_eff_ (this, vr) result (vg_eff)
    .. method:: vn_eff_ (this, vr) result (vn_eff)
    .. method:: D_surf_ (this, vr) result (D_surf)
    .. method:: Sigma_0_ (this) result (Sigma_0)
    .. method:: Sigma_1_ (this) result (Sigma_1)
    .. method:: A_surf_ (this) result (A_surf)
    .. method:: R_surf_ (this, theta) result (R_surf)
    .. method:: s_surf_ (this, vr_0, vdr) result (s_surf)
    .. method:: eval_c_ (this, z) result (f_z)
    .. method:: read_ (hg, st)
    .. method:: write_ (hg, st)
    .. method:: bcast_ (st, root_rank)



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

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