##############################
**Generating the fortran doc**
##############################

This module was written to generated documentation from docstrings for Fortran 2003 codes.

**Docstring format**
####################

For types, functions, and subroutiness

* !! For short docstring
* !- For long docstring

Also for input and output parameters, we add a comment at the end of the variable declaration, so that they are added to the long docstring.::

    function Phi_eff_ (this, vr) result (Phi_eff)
        !! Calculate the effective potential (units: G M_star/R_pole) at vr
        !- (units: R_pole)
        !-
        class(star_t), intent(in) :: this     !- :param this: a :class:`star_t` object
        real(WP), intent(in)      :: vr(:)    !- :param vr:   a position
        real(WP)                  :: Phi_eff  !- :return Phi_eff: the potential as position vr

Will render as:

.. function:: 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 :class:`star_t` object
   :param vr:   a position
   :return Phi_eff: the potential as position vr

.. note::

   Note the use of ``:class:`star_t``` to create a link to the star_t class.

**API-style information**
##########################

.. automodule:: autoFortran
    :members: