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.

Substitute intrasite links to documentation for other parts of the program.

make_srcdir_list(exclude_dirs)#

Like os.walk, except that:

  1. directories listed in exclude_dir are excluded with all their subdirectories

  2. absolute paths are returned

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

Process the documentation with Markdown to produce HTML.

recursive_dir_list(topdir, skip)#
warn(message)#
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