Skip to main content

Fortran domain and autodoc extensions to Sphinx

Project description

https://badge.fury.io/py/sphinx-fortran.svg https://travis-ci.org/VACUMM/sphinx-fortran.svg?branch=master https://readthedocs.org/projects/sphinx-fortran/badge/?version=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

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

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 and other pull request contributors.

Documentation

Website: http://sphinx-fortran.readthedocs.org

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-fortran-1.1.1.tar.gz (36.3 kB view details)

Uploaded Source

File details

Details for the file sphinx-fortran-1.1.1.tar.gz.

File metadata

  • Download URL: sphinx-fortran-1.1.1.tar.gz
  • Upload date:
  • Size: 36.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4

File hashes

Hashes for sphinx-fortran-1.1.1.tar.gz
Algorithm Hash digest
SHA256 e912e6b292e80768ad3cf580a560a4752c2c077eda4a1bbfc3a4ca0f11fb8ee1
MD5 f5aff1cf76a43ab77d3bd17c42b3033d
BLAKE2b-256 d8e4292785927159d8377d2a368b09a6245d9fb9de7d4ad09f5f21ac2e1619e6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page