Documentation Generators

FORD – Documentation generator for modern Fortran

FORD, short for FORtran Documenter, generates documentation for modern Fortran programs. It combines information extracted from source code with explanatory comments to produce a searchable HTML reference.

Alongside API descriptions, projects can include general documentation pages, mathematical expressions, and diagrams showing relationships within the codebase.

This is free and open source software.

Key Features

  • Extracts information about modules, programs, procedures, arguments, variables, and derived types.
  • Reads documentation comments embedded in source files, keeping explanations close to the relevant code.
  • Formats documentation using Markdown for headings, lists, links, and code examples.
  • Renders LaTeX mathematical notation through MathJax for scientific and numerical documentation.
  • Produces searchable documentation with links between related parts of the software.
  • Displays syntax-highlighted source files and provides access to raw source and downloads.
  • Can include source excerpts on documentation pages for procedures, programs, and derived types.
  • Generates Graphviz diagrams showing module dependencies, type relationships, and procedural call trees.
  • Controls graph depth and size to make diagrams more manageable for larger projects.
  • Supports hierarchical standalone pages for tutorials, background material, and other general information.
  • Includes non-Fortran source files with file-level documentation and syntax highlighting.
  • Filters documented entities by visibility and offers several ordering methods.
  • Supports source preprocessing and configurable documentation settings.
  • Accepts project configuration through Markdown metadata or a Fortran Package Manager configuration file.
  • Cross-platform support – runs on Linux and macOS.

Website: github.com/Fortran-FOSS-Programmers/ford
Support:
Developer: Fortran-FOSS-Programmers and contributors
License: GNU General Public License v3.0

FORD is written in Python. Learn Python with our recommended free books and free tutorials.


Related Software

Documentation Generators
JSDocAPI documentation generator for JavaScript
JavadocGenerate API documentation in HTML format
SphinxCreate intelligent and beautiful documentation for Python projects
phpDocumentorComplete documentation solution for PHP
DoxygenDocumentation system for C, C++, Java, Python and other languages
DocusaurusBuild, deploy and maintain documentation websites
mdBookCreate modern online books from Markdown files
YARDRuby documentation tool
StarlightDocumentation website framework
DoccoLiterate-programming-style documentation generator
Natural DocsDocumentation generator that supports 21 different languages
QuartoScientific and technical publishing system
AntoraModular documentation site generator
CryccoQuick and dirty documentation generator
ROBODocDocumentation tool similar to Javadoc

Read our verdict in the software roundup.


Best Free and Open Source Software LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software.

We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more.

Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion.

Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README.
Subscribe

Please read our Comment Policy before commenting.

Notify of
guest
0 Comments
Oldest
Newest Most Voted