ford package#

ford.convert_to_bool(name, option)#

Convert value ‘option’ to a bool, with a nice error message on failure. Expects a list from the markdown meta-data extension

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.main(proj_data, proj_docs, md)#

Main driver of FORD.

ford.parse_arguments(command_line_args, proj_docs, directory='/home/docs/checkouts/readthedocs.org/user_builds/forddocs/checkouts/stable/docs')#

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#