ford package#

ford.get_command_line_arguments()#

Read the command line arguments

Return type:

Namespace

ford.initialize()#

Method to parse and check configurations of FORD, get the project’s global documentation, and create the Markdown reader.

ford.load_settings(proj_docs, directory=PosixPath('.'))#

Load Ford settings from fpm.toml if present, or from metadata in supplied project file1

Parameters:

  • proj_docs (str) – Text of project file

  • directory (Union[PathLike, str]) – Project directory

Return type:

Tuple[str, ProjectSettings]

Returns:

  • proj_docs (str) – Text of project file converted from markdown

  • proj_data (dict) – Project settings

ford.main(proj_data, proj_docs)#

Main driver of FORD.

ford.parse_arguments(command_line_args, proj_docs, proj_data, directory=PosixPath('.'))#

Consolidates arguments from the command line and from the project file, and then normalises them how the rest of the code expects

ford.run()#
ford.stdout_redirector(stream)#

Submodules#