ford.fortran_project module#

class ford.fortran_project.Project(settings)#

Bases: object

An object which collects and contains all of the information about the project which is to be documented.

property allfiles#

Instead of duplicating files, it is much more efficient to create the itterator on the fly

correlate()#

Associates various constructs with each other.

find(name, entity=None, child_name=None, child_entity=None)#

Find an entity somewhere in the project

Parameters:

  • name (str) – Name of entity to look up

  • entity (Optional[str]) – The class of entity (module, program, and so on)

  • child_name (Optional[str]) – Name of a child of name to look up

  • child_entity (Optional[str]) – The class of child_name

Returns:

Returns None if name not found

Return type:

Optional[FortranBase]

markdown(md, base_url='..')#

Process the documentation with Markdown to produce HTML.

warn(message)#
ford.fortran_project.find_all_files(settings)#

Returns a list of all selected files below a set of directories

Return type:

List[Path]

ford.fortran_project.find_used_modules(entity, modules, submodules, external_modules)#

Find the module objects (or links to intrinsic/external module) for all of the USED``d names in ``entity

Parameters:
Return type:

None