Autogenerated Fortran docs using FORD

This is a basic example of using FORD to document Fortran projects. FORD is very simple and lightweight.

Install

FORD is a python program:

pip install ford

Usage

Each project will have a ford.md that configures and makes description for the main project landing page.

If your code is all under the top-level directory, set ford.md like: (this example is for our fortran2018-examples repo)

src_dir: ./
output_dir: ./docs
project: Fortran 2018 examples
project_github: https://github.com/scivision/fortran2018-examples
project_website: https://scivision.github.io/fortran2018-examples
summary: Fortran 2008 / 2018 examples
author: Michael Hirsch Ph.D.
author_description: SciVision, Inc.
github: https://github.com/scivision
license: by
exclude: CMakeFortranCompilerId.F
display: public
         protected
         private
source: false
graph: true
search: true

Put Markdown test of arbitrary length here.
Within the Fortran code, use `!!` on each line with Markdown, Latex, etc.

Notes

Categories:

Comments

Written by Michael Hirsch, Ph.D. //