Skip to main content

FORD

Latest Version Latest homebrew version Latest spack version PyPI Total Downloads GitHub license DOI

This is an automatic documentation generator for modern Fortran programs. FORD stands for FORtran Documenter. As you may know, "to ford" refers to crossing a river (or other body of water). It does not, in this context, refer to any company or individual associated with cars.

Ford was written due to Doxygen's poor handling of Fortran and the lack of comparable alternatives. ROBODoc can't actually extract any information from the source code and just about any other automatic documentation software I found was either proprietary, didn't work very well for Fortran, or was limited in terms of how it produced its output. f90doc is quite good and I managed to modify it so that it could handle most of Fortran 2003, but it produces rather ugly documentation, can't provide as many links between different parts of the documentation as I'd like, and is written in Perl (which I'm not that familiar with and which lacks the sort of libraries found in Python for producing HTML content).

The goal of FORD is to be able to reliably produce documentation for modern Fortran software which is informative and nice to look at. The documentation should be easy to write and non-obtrusive within the code. While it will never be as feature-rich as Doxygen, hopefully FORD will be able to provide a good alternative for documenting Fortran projects.

Capabilities

Current features include:

  • the ability to extract information about variables, procedures, procedure arguments, derived types, programs, and modules from the source code.
  • the ability to extract documentation from comments in the source code.
  • LaTeX support in documentation using MathJax.
  • searchable documentation, using Lunr Search.
  • author description and social media (including Github!) links.
  • links to download the source code.
  • links to individual files, both in their raw form or in HTML with syntax highlighting.
  • use of Markdown to type-set documentation.
  • links between related parts of the software.
  • Bootstrap CSS for the documentation, making it both functional and pretty.
  • configurable settings.
  • ability to create a hierarchical set of pages containing general information, not associated with any particular part of the source code.
  • display an entry for non-Fortran source files with file-level documentation and syntax highlighted code.

Installation

The simplest way to install FORD is using pip:

pip install ford

Pip will automatically handle all dependencies for you. By default this will place ford in ~/.local/bin -- you might need to add this to your PATH.

Alternatively, FORD is available through the Homebrew package manager for Mac OS X. To update Homebrew and install FORD, run these commands in a terminal:

brew update
brew install FORD

If you would like to install the latest development (master) branch from github, simply add the --HEAD flag: brew install --HEAD FORD

FORD is also available through the spack package manager by running the following command:

spack install py-ford

Documentation

More complete documentation can be found in the docs.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but without any warrenty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see the GNU website.

Documents produced by FORD are derivative works derived from the input used in their production; they are not affected by this license.

Metadata

Release files for FORD 7.0.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for FORD 7.0.11
File Size Uploaded Provenance Actions
ford-7.0.11.tar.gz 6.3 MB Without provenance Details for ford-7.0.11.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for FORD 7.0.11
File Interpreter ABI Platform Actions
ford-7.0.11-py3-none-any.whl Python 3 none any Details for ford-7.0.11-py3-none-any.whl

Total release size: 7.2 MB

Release files / ford-7.0.11.tar.gz

Download URL ford-7.0.11.tar.gz
Size 6.3 MB
Tags Source
SHA-256 checksum
How to use checksums
d682372592de3414e10db6baee3e8bf52867006cf0b198f42b82ea735015128b
BLAKE2b-256 checksum
How to use checksums
96fee06d62822f8eb66e068066c4a342f2dc79c4e6e9c3fef97fd4f80aa73353
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Release files / ford-7.0.11-py3-none-any.whl

Download URL ford-7.0.11-py3-none-any.whl
Size 835.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5b5d296aae452e8653a6335a5471115e869371110b8d76139933ca839f4f9dd4
BLAKE2b-256 checksum
How to use checksums
475068f13b0fa05ea38c03a46a3e7fb386dc5e98ba5d8263c8d2a00d18a1a4cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Security for FORD 7.0.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

7.0.11 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page