Metadata-Version: 1.0
Name: sphinx-fortran
Version: 1.0.1
Summary: Fortran domain and autodoc extensions to Sphinx
Home-page: http://sphinx-fortran.readthedocs.org
Author: Stephane Raynaud
Author-email: stephane.raynaud@gmail.com
License: CeCiLL-A
Description: Sphinx-Fortran extensions
        =========================
        
        .. image:: https://badge.fury.io/py/sphinx-fortran.svg
            :target: https://badge.fury.io/py/sphinx-fortran
        
        .. image:: https://travis-ci.org/VACUMM/sphinx-fortran.svg?branch=master
            :target: https://travis-ci.org/VACUMM/sphinx-fortran
        
        .. image:: https://readthedocs.org/projects/sphinx-fortran/badge/?version=latest
            :target: http://sphinx-fortran.readthedocs.org/en/latest/?badge=latest
        
        
        Purpose
        -------
        
        This package provides two Sphinx (http://sphinx.pocoo.org/) extensions
        to the Fortran (90) language:
        
        - ``sphinxfortran.fortran_domain``: Sphinx domain for fortran.
        - ``sphinxfortran.fortran_autodoc``: Auto-documenting fortran code.
        
        
        License
        -------
        
        This package has the same license as VACUMM (http://www.ifremer.fr/vacumm)
        from which it originates: CeciLL-A
        (http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html),
        which is compatible with the GPL.
        
        
        Prerequisites
        -------------
        
        The ``sphinx`` and ``numpy`` packages.
        
        
        Installation
        ------------
        
        Using ``pip``::
        
            pip install sphinx-fortran
        
        From sources::
        
            git clone https://github.com/VACUMM/sphinx-fortran.git
            cd sphinx-fortran
            python setup.py install
        
        You can download sources also from the forge at IFREMER:
        https://forge.ifremer.fr/frs/?group_id=93
        
        
        Quick start
        -----------
        
        1. Add this extension to your sphinx ``conf.py``.
        2. List you fortran source files in the variable
           ``fortran_src`` of your ``conf.py``.
        3. Generate their documentation in rst files using
           directives like::
        
               .. f:automodule:: mymodule
        
        
        Bugs and requests
        -----------------
        
        Please go to this GitHub page:
        https://github.com/VACUMM/sphinx-fortran/issues
        
        
        Authors
        -------
        
        Stephane Raynaud (stephane.raynaud(at)gmail.com)
        
        Thanks: Thomas Gastine
        
        
        Documentation
        -------------
        
        Website: http://sphinx-fortran.readthedocs.org
        
        
Platform: UNKNOWN
