.. 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
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.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.
The sphinx
and numpy
packages.
With pip
::
pip install sphinx-fortran
With conda
::
conda install -c vacumm -c conda-forge sphinx-fortran
From sources::
git clone https://github.com/VACUMM/sphinx-fortran.git
cd sphinx-fortran
python setup.py install
conf.py
.fortran_src
of your conf.py
.Generate their documentation in rst files using directives like::
.. f:automodule:: mymodule
Please go to this GitHub page: https://github.com/VACUMM/sphinx-fortran/issues
Stephane Raynaud (stephane.raynaud(at)gmail.com)
Thanks: Thomas Gastine and other pull request contributors.