sphinx-ford

A Sphinx domain for Fortran with a FORD bridge for automatic documentation of Fortran source code.

sphinx-ford provides a Fortran language domain (f) for Sphinx, enabling you to document Fortran modules, procedures, types, and other entities directly in reStructuredText. It also includes a bridge to FORD for auto-documenting Fortran source code.

Tutorials

• Getting started with sphinx-ford
  • Installing sphinx-ford
  • Setting up the project
  • Writing our first module
  • Building and viewing the result
  • Adding cross-references
  • What we have created
• Auto-documenting Fortran sources with FORD
  • Installing FORD
  • Creating a FORD project file
  • Configuring the bridge
  • Using automodule
  • Building and viewing the result
  • What we have built

How-to guides

• Installing and using sphinx-ford
  • Install sphinx-ford with pip
  • Install from GitHub
  • Enable in Sphinx
• How to structure nested module documentation
  • Define entities inside f:module
  • Document members and bound procedures in f:type
  • Set context across split files with f:currentmodule
• How to cross-reference Fortran entities
  • Reference by entity name
  • Reference an entity in another module
  • Handle case-insensitive names
  • Reference type components
• How to auto-document a FORD project
  • Configure a single FORD project
  • Configure multiple FORD projects
  • Handle CMake-templated FORD files
  • Disable preprocessing
  • Export for FORD cross-linking
• How to document parameter constants and type members
  • Document a parameter constant
  • Document a type component (member)
  • Reference members and parameters
  • Automatic detection via FORD
• How to set up cross-project linking
  • Link from one sphinx-ford project to another
  • Link from sphinx-ford to a FORD site
  • Link from FORD to sphinx-ford pages

Reference

• Directives reference
  • Entity directives
  • Context directives
  • FORD bridge directives
  • Doc fields (procedures)
• Roles reference
  • Name resolution
• Configuration reference
  • Extension setup
  • FORD bridge options

Examples

• Examples
  • TOML Fortran (toml-f)
  • Fortran Package Manager (fpm)
  • Fortran Standard Library (stdlib)
  • DBCSR: Sparse Matrix Library
  • AOTUS: Lua scripting for Fortran