使用 Homebrew, Nix 安装 ford

项目链接

• 主页

命令和别名

• ford

项目历史

FORD was written because the maintainer found Doxygen's Fortran handling poor and other alternatives limited, proprietary, unattractive, or difficult to extend. The README specifically compares it with ROBODoc, f90doc, and Doxygen and states the goal of producing modern Fortran documentation that is informative, attractive, easy to write, and non-obtrusive.

The documentation site later formalized the user guide around project files, Markdown metadata, fpm.toml integration, command-line options, generated pages, and API documentation. The changelog shows an active 6.x and 7.x period, including Sphinx/Read the Docs documentation work and a v7.0.0 breaking-change release.

采用历史

The README documents pip as the simplest installation path, Homebrew as a macOS package-manager route, and additional system package availability. It also displays badges for PyPI, Homebrew, package status, downloads, GitHub license, and Zenodo, indicating packaging and citation concerns common in scientific Fortran projects.

使用方式

Users write a Markdown project file, optionally put settings in fpm.toml, and run ford against the project file. FORD extracts documentation from Fortran comments, supports Markdown, MathJax, search, Bootstrap-based output, source links, static pages, and external project references.

为什么软件包爱好者会关心

FORD matters to package and scientific-computing maintainers because it fills a language-specific documentation gap for modern Fortran while fitting normal Python packaging and Homebrew workflows. It also bridges Fortran Package Manager projects through fpm.toml support.

时间线

• 2022: changelog entry v6.1.17 includes adding Sphinx docs and a Read the Docs website.
• 2023: v6.2.5 released with fixes around bound procedure declarations and call graphs.
• v7.0.0: changelog records a breaking release updating Bootstrap to 5.3 and changing project-file metadata behavior.

Related projects

• The README discusses Doxygen, ROBODoc, and f90doc as related documentation tools. The user guide also connects FORD to fpm.toml, Markdown, MathJax, Lunr Search, Bootstrap, and external FORD documentation projects.

来源

• https://forddocs.readthedocs.io/en/latest/user_guide/project_file_options.html
• https://forddocs.readthedocs.io/en/latest/user_guide/writing_documentation.html
• https://github.com/Fortran-FOSS-Programmers/ford
• https://raw.githubusercontent.com/Fortran-FOSS-Programmers/ford/master/CHANGELOG.md
• https://raw.githubusercontent.com/Fortran-FOSS-Programmers/ford/master/README.md