ford.settings module#
- class ford.settings.EntitySettings(author=None, category=None, copy_subdir=<factory>, date=None, deprecated=False, display=<factory>, graph=False, graph_maxdepth=10000, graph_maxnodes=1000000000, license=None, num_lines=None, ordered_subpage=<factory>, proc_internals=False, since=None, source=False, summary=None, title=None, version=None)#
Bases:
object
- classmethod from_markdown_metadata(meta, parent=None)#
- classmethod from_project_settings(project_settings)#
Inherit entity-specific settings from project-level settings
- class ford.settings.ExtraFileType(extension, comment, lexer=None)#
Bases:
object
- classmethod from_string(string)#
- class ford.settings.ProjectSettings(alias=<factory>, author=None, author_description=None, author_pic=None, bitbucket=None, coloured_edges=False, copy_subdir=<factory>, creation_date='%Y-%m-%dT%H:%M:%S.%f%z', css=None, dbg=True, display=<factory>, doc_license='', docmark='!', docmark_alt='*', email=None, encoding='utf-8', exclude=<factory>, exclude_dir=<factory>, extensions=<factory>, external=<factory>, externalize=False, extra_filetypes=<factory>, extra_mods=<factory>, extra_vartypes=<factory>, facebook=None, favicon=PosixPath('favicon.png'), fixed_extensions=<factory>, fixed_length_limit=True, force=False, fpp_extensions=<factory>, github=None, gitlab=None, gitter_sidecar=None, google_plus=None, graph=False, graph_dir=None, graph_maxdepth=10000, graph_maxnodes=1000000000, hide_undoc=False, incl_src=True, include=<factory>, license='', linkedin=None, lower=False, macro=<factory>, mathjax_config=None, max_frontpage_items=10, md_base_dir=PosixPath('.'), md_extensions=<factory>, media_dir=None, output_dir=PosixPath('doc'), page_dir=None, parallel=2, predocmark='>', predocmark_alt='|', preprocess=True, preprocessor='pcpp -D__GFORTRAN__ --passthru-comments', print_creation_date=False, privacy_policy_url=None, proc_internals=False, project='Fortran Program', project_bitbucket=None, project_download=None, project_github=None, project_gitlab=None, project_sourceforge=None, project_url='', project_website=None, quiet=False, revision=None, search=True, show_proc_parent=False, sort='src', source=False, src_dir=<factory>, summary=None, terms_of_service_url=None, twitter=None, version=None, warn=False, website=None, year='2024')#
Bases:
object
-
extra_filetypes:
Dict
[str
,ExtraFileType
]#
- classmethod from_markdown_metadata(meta, parent=None)#
- normalise_paths(directory=None)#
-
extra_filetypes:
- ford.settings.convert_setting(default_type, key, value)#
Convert an individual value’s type to be consistent with a given dataclass for the given key.
- Return type:
- ford.settings.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
- Return type:
- ford.settings.convert_types_from_commandarguments(settings, cargs, parent=None)#
Convert the cargs dict’s value’s types to be consistent with a given dataclass if set and override them in settings.
- ford.settings.convert_types_from_metapreprocessor(cls, settings, parent=None)#
Convert a dict’s value’s types to be consistent with a given dataclass
- ford.settings.is_optional_type(tp, sub_tp)#
Returns True if
tp
isOptional[sub_tp]
- Return type:
- ford.settings.is_same_type(type_in, tp)#
Returns True if
type_in
is the same type as eithertp
orOptional[tp]
- Return type:
- ford.settings.load_markdown_settings(directory, project_file, filename=None)#
- Return type:
- ford.settings.load_toml_settings(directory)#
Load Ford settings from
fpm.toml
file indirectory
Settings should be in
[extra.ford]
table- Return type: