Project Files

The project file is simply a plain text file that contains information about your project. You can specify a project file using the --project_info option.

A project file contains informational elements which have the form TYPE: VALUE. The following values for TYPE are supported:

The following possible values of VALUE are supported:

Example

An example project file is shown below

Name: Timers
Tagline: Making timing easy.

Menu: menu.md
Markup: markdown

UserPage: index.md
UserPage: filelist.md
UserPage: modulelist.md

Source: ../src/*.f90

ShowSource:
> Type: File
> Type: Program

Searchable:
> Type: Program
> Type: DerivedType
> Type: Assignment
> Type: Overload
> Type: Operator
> Type: Function
> Type: Subroutine