Changelog

v7.0.0

Breaking changes:

It is no longer possible to include other files in the project file metadata
The Bootstrap CSS framework has been updated to 5.3, which might break project's custom CSS

Changes:

Use a table for extra_mods in TOML config [#574][#574] ([ZedThree][https://github.com/ZedThree])
Update docs for setting options in fpm.toml [#573][#573] ([ZedThree][https://github.com/ZedThree])
Fix links to intrinsic mods [#572][#572] ([ZedThree][https://github.com/ZedThree])
Fix some display issues for type bound procedures [#571][#571] ([ZedThree][https://github.com/ZedThree])
Switch default preprocessor to pcpp [#570][#570] ([ZedThree][https://github.com/ZedThree])
Bump minimum required version of Jinja2 [#568][#568] ([ZedThree][https://github.com/ZedThree])
Give some context in more warnings [#563][#563] ([ZedThree][https://github.com/ZedThree])
Fix relative urls on nested pages from expanded aliases [#562][#562] ([ZedThree][https://github.com/ZedThree])
More and fancier progress bars using rich [#561][#561] ([ZedThree][https://github.com/ZedThree])
Fix for docstrings on unnamed interface blocks [#560][#560] ([ZedThree][https://github.com/ZedThree])
Add option to specify any project setting on the command line [#559][#559] ([ZedThree][https://github.com/ZedThree])
Improve exclude and exclude_dir options [#558][#558] ([ZedThree][https://github.com/ZedThree])
Specify extra_filetypes as a dict in toml settings files [#557][#557] ([ZedThree][https://github.com/ZedThree])
Fix bugs in new admonitions [#556][#556] ([ZedThree][https://github.com/ZedThree])
Resolve Ford links in context of current entity [#555][#555] ([ZedThree][https://github.com/ZedThree])
Convert sub_links to markdown extension [#554][#554] ([ZedThree][https://github.com/ZedThree])
Convert sub_macros to a markdown extension [#553][#553] ([ZedThree][https://github.com/ZedThree])
Delay applying markdown conversion till after correlate step [#552][#552] ([ZedThree][https://github.com/ZedThree])
Convert settings to a dataclass [#551][#551] ([ZedThree][https://github.com/ZedThree])
External project refactor [#550][#550] ([ZedThree][https://github.com/ZedThree])
Upgrade to bootstrap 5.3 [#548][#548] ([ZedThree][https://github.com/ZedThree])
Use settings from extra.ford in fpm.toml file if it exists [#547][#547] ([umbrella1989][https://github.com/umbrella1989])
Fix more tests on windows [#543][#543] ([MEJ2235][https://github.com/MEJ2235])
Pull out metapreprocessor [#542][#542] ([MEJ2235][https://github.com/MEJ2235])
Add support for namelists [#541][#541] ([kpb510][https://github.com/kpb510])
Handle notes, etc. with MD admonitions (replaces #410) [#540][#540] ([ZedThree][https://github.com/ZedThree])
Include type-bound procedures in call graphs if binding not visible [#539][#539] ([ZedThree][https://github.com/ZedThree])
Relax version on pygments [#537][#537] ([dschwoerer][https://github.com/dschwoerer])
Make calls recognize associations [#536][#536] ([JosephWood2001][https://github.com/JosephWood2001])
Fix some issues in docs [#534][#534] ([ZedThree][https://github.com/ZedThree])
Fix some tests for Windows [#533][#533] ([ZedThree][https://github.com/ZedThree])
Fix missing labels on codeunits [#532][#532] ([JosephWood2001][https://github.com/JosephWood2001])
fix issues in PR#528 [#531][#531] ([JosephWood2001][https://github.com/JosephWood2001])
Fix call chains [#529][#529] ([JosephWood2001][https://github.com/JosephWood2001])
Add more type hinting, and some general tidy up [#528][#528] ([ZedThree][https://github.com/ZedThree])
Adding HTML escaping of initial values [#527][#527] ([interkosmos][https://github.com/interkosmos])
Try to give a more helpful error message when parsing has failed [#526][#526] ([ZedThree][https://github.com/ZedThree])
Fix call chain parsing for some edge cases [#525][#525] ([JosephWood2001][https://github.com/JosephWood2001])
Add procedure binding calls to call graph [#524][#524] ([JosephWood2001][https://github.com/JosephWood2001])
Refactor static pages code; Ensure static pages are read with project encoding [#521][#521] ([ZedThree][https://github.com/ZedThree])
calls to variables within a type no longer get added to call graph [#520][#520] ([JosephWood2001][https://github.com/JosephWood2001])
fix internal procedure's calls not showing up in call graphs [#514][#514] ([JosephWood2001][https://github.com/JosephWood2001])
pyproject.toml: fix setuptools warnings [#513][#513] ([band-a-prend][https://github.com/band-a-prend])

v6.2.5 (2023-05-05)

Full Changelog

Make double-colon in bound procedure declaration optional [#512][#512] ([ZedThree][https://github.com/ZedThree])
Some minor refactoring [#511][#511] ([ZedThree][https://github.com/ZedThree])
Fix bind names for subroutines, and pull out common base class for procedures [#510][#510] ([ZedThree][https://github.com/ZedThree])
add typebound procedures to call graph, and show the bound type on procedures' page [#509][#509] ([JosephWood2001][https://github.com/JosephWood2001])

v6.2.4 (2023-04-05)

Full Changelog

Fix displaying graphs as tables [#503][#503] ([ZedThree][https://github.com/ZedThree])

v6.2.3 (2023-04-03)

Full Changelog

Fixed broken link to Meta-Data reference [#498][#498] ([blaylockbk][https://github.com/blaylockbk])
Add show_proc_parent option for graphs [#497][#497] ([JosephWood2001][https://github.com/JosephWood2001])
Fix for max_frontpage_items [#496][#496] ([RMShur][https://github.com/RMShur])

v6.2.2 (2023-03-24)

Full Changelog

Fix graphs for recursive procedures [#495][#495] ([ZedThree][https://github.com/ZedThree])
Try to be much more consistent about handling str in graphs [#494][#494] ([ZedThree][https://github.com/ZedThree])

v6.2.1 (2023-03-22)

Full Changelog

Add regression test against collection of repos [#490][#490] ([ZedThree][https://github.com/ZedThree])
Fix parsing character declarations when len= is not present [#489][#489] ([ZedThree][https://github.com/ZedThree])
Fix some regressions in graphs [#488][#488] ([ZedThree][https://github.com/ZedThree])
doc: add total PyPI download badge [#486][#486] ([scivision][https://github.com/scivision])

v6.2.0 (2023-03-16)

Full Changelog

Convert setup.cfg to pyproject.toml [#485][#485] ([ZedThree][https://github.com/ZedThree])
Graphs refactor [#484][#484] ([ZedThree][https://github.com/ZedThree])
Fix block data output class [#480][#480] ([ZedThree][https://github.com/ZedThree])
Handle procedure pointers and dummy procedures in interface blocks [#479][#479] ([ZedThree][https://github.com/ZedThree])
Fix setuptools deprecation warnings [#474][#474] ([band-a-prend][https://github.com/band-a-prend])
Fix tests for Python 3.11 [#467][#467] ([ZedThree][https://github.com/ZedThree])
Fix command line option docs [#465][#465] ([ZedThree][https://github.com/ZedThree])
Drop support for Python 3.7 [#453][#453] ([ZedThree][https://github.com/ZedThree])

v6.1.17 (2022-11-22)

Full Changelog

Some fixes for module procedures [#463][#463] ([ZedThree][https://github.com/ZedThree])
Revert adding default values to CLI interface [#462][#462] ([ZedThree][https://github.com/ZedThree])
Docs: rst fixes for LaTeX syntax [#460][#460] ([Meax5qiu][https://github.com/Meax5qiu])
Fix src_dir command line option [#459][#459] ([ZedThree][https://github.com/ZedThree])
Fix doc summaries for types; other minor bugs [#457][#457] ([ZedThree][https://github.com/ZedThree])
Add Sphinx docs and Readthedocs website [#454][#454] ([ZedThree][https://github.com/ZedThree])
Refactor jinja macros [#452][#452] ([ZedThree][https://github.com/ZedThree])

v6.1.16 (2022-10-05)

Full Changelog

Fix type-bound procedure docs not showing full docstring [#451][#451] ([ZedThree][https://github.com/ZedThree])
read project file with utf8 encoding [#448][#448] ([St-Maxwell][https://github.com/St-Maxwell])

v6.1.15 (2022-07-25)

Full Changelog

Fix bad attribute rename [#444][#444] ([ZedThree][https://github.com/ZedThree])

v6.1.14 (2022-07-21)

Full Changelog

Tidy fortran_project.correlate and fix some minor bugs [#442][#442] ([ZedThree][https://github.com/ZedThree])
Better error messages when parsing [#441][#441] ([ZedThree][https://github.com/ZedThree])
Fix quoted URLs in extra_mods input not being removed [#439][#439] ([ZedThree][https://github.com/ZedThree])
Pin dependencies; bump required markdown-include version [#438][#438] ([ZedThree][https://github.com/ZedThree])
Added -g/--graph argument to command parser. [#435][#435] ([lizzyd710][https://github.com/lizzyd710])

v6.1.13 (2022-07-01)

Full Changelog

Small tidying up of graph modules [#434][#434] ([ZedThree][https://github.com/ZedThree])
Fix hang when creating graphs during writing documentation [#433][#433] ([ZedThree][https://github.com/ZedThree])
Update README with spack installation and badge [#430][#430] ([lizzyd710][https://github.com/lizzyd710])

v6.1.12 (2022-06-16)

Full Changelog

Only fall back to unpreprocessed file if preprocessing fails [#426][#426] ([ZedThree][https://github.com/ZedThree])
Fix filtering public entities not lowercasing name [#425][#425] ([ZedThree][https://github.com/ZedThree])
External: Fix extending external types with [#420][#420] ([haraldkl][https://github.com/haraldkl])
Minor refactoring of output.py [#419][#419] ([ZedThree][https://github.com/ZedThree])
External projects: Actually return the generated object in dict2obj [#418][#418] ([haraldkl][https://github.com/haraldkl])
Do not fail on existing MathJax-config directory [#415][#415] ([Meax5qiu][https://github.com/Meax5qiu])

v6.1.11 (2022-04-04)

Full Changelog

Fix change to exclude behaviour [#408][#408] ([ZedThree][https://github.com/ZedThree])
Fix bad conversion to str in sort: type-alpha [#401][#401] ([ZedThree][https://github.com/ZedThree])

v6.1.10 (2022-03-14)

Full Changelog

Fix for FortranVariable sharing references to lists [#400][#400] ([ZedThree][https://github.com/ZedThree])

v6.1.9 (2022-03-14)

Full Changelog

Fixed bugs:

FORD tries to run the preprocessor even if preprocessor test failed #398
exclude_dir is broken in 6.1.8 #391
Preprocessing broken? #389
Derived Types header missing #388
source display broken #387

Closed issues:

ford-6.1.8 test: test_projects/test_external_project.py is broken #395
Ugly tables in markdown pages #373

Merged pull requests:

Fix external project test #397 (ZedThree)
External projects: deal with extended types #396 (haraldkl)
Fix exclude_dirs #394 (ZedThree)
Fix for preprocessors that can't read from stdin #393 (ZedThree)
Fix type permission attributes #392 (ZedThree)
Fix showing source in generated docs #390 (ZedThree)
Update math and environ markdown extensions #385 (ZedThree)
Fix CSS for markdown tables and add optional striped-table extension #384 (ZedThree)

v6.1.8 (2022-02-01)

Full Changelog

Fixed bugs:

Fails with TypeError for preprocessing file #380

Closed issues:

LaTeX macros #361
Installing on macOS Big Sur #351

Merged pull requests:

Fix local external project #382 (ZedThree)
Fix preprocessor command #381 (ZedThree)

v6.1.7 (2022-01-31)

Full Changelog

Merged pull requests:

Fix multiline attributes #379 (ZedThree)
Fix black action to work on forks; only run on changes to .py files #376 (ZedThree)
deps: need importlib-metadata #375 (chenrui333)
Tidy up and refactor initialisation #365 (ZedThree)

v6.1.6 (2022-01-04)

Full Changelog

Fixed bugs:

'str object' has no attribute 'meta' - error when abstract interface imported from different module #372

Merged pull requests:

add asterisks to list of mangled symbols #374 (chucklesoclock)

v6.1.5 (2021-09-23)

Full Changelog

Closed issues:

Question: comment in project file? #210

Merged pull requests:

Enable aliases in docstrings #363 (ZedThree)
Fixed module variable INTRINSIC_MODS being changed implicitly. #362 (byornski)
Make sure "Find us on" present if project_gitlab set #359 (d7919)
Fixed invalid check for : character in extra_mods. #358 (byornski)

v6.1.4 (2021-09-13)

Full Changelog

Implemented enhancements:

pybuilder and test coverage #13

Fixed bugs:

Footnotes in Pages #327
Code blocks don't seem to work within subroutines #287
Markdown headers do not work as expected #286

Merged pull requests:

Fix indentation in markdown blocks and footnotes appearing on multiple pages #356 (ZedThree)

v6.1.3 (2021-09-10)

Full Changelog

Fixed bugs:

Case sensitivity for MODULE SUBROUTINE #353
Release 6.0.0 does not contain ford/js/MathJax-config #325
Multi-line strings containing an exclamation mark #320
"Unknown Procedure Type" in call tree #319
Warning: Could not extract source code for proc #299
Exception: Alternate documentation lines can not be inline error #295
Support enums with kind specified for integer literals #243

Merged pull requests:

Fix several bugs #354 (ZedThree)

v6.1.2 (2021-09-06)

Full Changelog

Implemented enhancements:

Automatic publishing of releases #332

Fixed bugs:

jinja2.exceptions.UndefinedError: 'None' has no attribute 'meta' #352
somehow FORD takes number in Format as subroutine to draw the graph #350
Unclear exception raised #292
Different results with space after '%' character. #240

v6.1.1 (2021-07-20)

Full Changelog

v6.1.0 (2021-07-20)

Full Changelog

Implemented enhancements:

Switch for ignoring undocumented entities #163
Automatic publishing of releases #332

Fixed bugs:

Broken links for the intrinsic modules #343
Submodules lead to a crash - 'FortranModule' object has no attribute 'all_absinterfaces' #322
Question: disable sourcecode pages #314
Bad escape crash #296
UnicodeDecodeError #270
ford 5.0.6 crashes on sync images inside module procedure in submodule #237

Closed issues:

black? #334
Crash with macro #45

Merged pull requests:

Add workflow for publishing to PyPI on release #348 (ZedThree)
Fix flake8 warnings #347 (ZedThree)
Convert setup.py to setup.cfg/pyproject.toml #346 (ZedThree)
Fix and update URLs for intrinsic modules. #344 (ZedThree)
Apply black formatting to project; add auto-black to CI #342 (ZedThree)
Linking to external projects #338 (haraldkl)
Use rawstring literals for regexes #337 (ZedThree)
Fix for crash when character default value contains backslash #336 (ZedThree)
Add a few unit tests #335 (ZedThree)
Add support for python -m ford #333 (dschwoerer)
Warn on missing include files instead of error #331 (dschwoerer)
Add a trivial regression test #330 (ZedThree)
Allow submodule procedures to have CONTAINS statements #321 (pzehner)
Specify order of the subpages in page_dir #318 (ecasglez)
Do not show the list of source files in index.html if incl_src is false. #316 (ecasglez)
Change the link to the github repo in the generated html. #315 (ecasglez)
Fix: include files were only processed if the word "include" was lowercase #313 (ecasglez)
Fix missing parentheses on str.lower call #311 (ZedThree)
Fix anchors being hid by navbar for all elements #310 (ZedThree)
Prevent IndexError on single ampersands #306 (ajdawson)
Adding a trivial regression test #305 (pclausen)
Added a copy_subdir option. #302 (haraldkl)
Added the option to define aliases for the documentation by the user. #301 (haraldkl)
fix directory names in error message #300 (shoshijak)
src: Add gitlab as an option #297 (HaoZeke)
Adding feature to project licenses #294 (kevinhng86)
Extends now recognised if capitalised #289 (oerc0122)
Fix 267: Inc. all proc doc when missing read more #282 (zbeekman)
Fix #273: Ensuring set is used for module uses data #281 (d7919)
Only loop over first ten objects in bottom nav links #279 (ZedThree)
Add source code line values to raised exceptions #277 (smillerc)
Fixing links in the README files #268 (tueda)
Add project-file option to hide undocumented elements #266 (jhrmnn)
Fix invalid "Read more" for components of derived types #265 (jhrmnn)
Fixed copying MathJax config file #264 (cmacmackin)
choose encoding and create --force mode #263 (narsonalin)
sourceform: Check for both function calls and sub calls on same line #257 (kc9jud)
recognizing data type: double complex (issue #251) #252 (PaulXiCao)
Hide the progress bars when running quietly #244 (ibarrass-qmul)

v6.0.0 (2018-06-30)

Full Changelog

Implemented enhancements:

Reducing html size #205
Links to routines not included in documentation #182
slow rendering of large graphs #176
Sources always included, is it possible to customize? #172

Fixed bugs:

UnicodeDecodeError: 'utf8' codec can't decode byte #208
Incorrect relative path (project_url) in index.html #204
Failure in generating HTML with procedure statement #202
MathJax extension doesn't work with nested/recursive patterns #196
Graph shows calls to module variables #190
Maximum recursion depth with recursive types #183
OOM and RecursionError with large code base #174

Merged pull requests:

sources can now be excluded from html output #241 (jburgalat)
Activate graph warnings if any object in the root list has warn true (#231) #234 (haraldkl)
Addressing #219 #220 (haraldkl)
Re-enable graphs as table and adapt them to changed graph layout. #218 (haraldkl)
added support for specifying lexer of extra_filetypes #217 (cmacmackin)
Fix graphlimiting #216 (haraldkl)
Filter empty preprocessor flags; don't treat arithmetic gotos as function references #214 (ibarrass-qmul)
Be case insensitive when searching for entities which are imported by a use statement. #201 (sch1ldkr0ete)
Introduced a maximal graph depth option to limit graph sizes. #197 (haraldkl)
Added an option mathjax_config for custom setting. #195 (mrestelli)
Skip subdirectories of directories listed in exclude_dir #194 (mrestelli)
bug: fixed replacements in name conversion #192 (zerothi)
enh: reduced memory consumption and speeded up process #191 (zerothi)
Fix minor typo in tipuesearch create_node call #186 (d7919)
Fix for hidden anchors within pages. #178 (sch1ldkr0ete)
Reducing page rendering time #175 (sch1ldkr0ete)
Better example #169 (zbeekman)

v5.0.6 (2016-09-16)

Full Changelog

Merged pull requests:

fixed python3 bug. #170 (jacobwilliams)

v5.0.5 (2016-09-15)

Full Changelog

Merged pull requests:

Update installation documentation for pip install. #168 (rouson)
Fix base.html to use correct author in the head section. #164 (aradi)

v5.0.4 (2016-07-27)

Full Changelog

v5.0.3 (2016-07-27)

Full Changelog

v5.0.2 (2016-07-26)

Full Changelog

v5.0.1 (2016-07-26)

Full Changelog

v5.0.0 (2016-07-26)

Full Changelog

v4.6.2 (2016-06-11)

Full Changelog

v4.6.1 (2016-06-05)

Full Changelog

v4.6.0 (2016-05-15)

Full Changelog

Merged pull requests:

Add homebrew version badge #133 (zbeekman)
Implement customizable preprocessor. #129 (aradi)
Fix ford not to exit silently when encountering deep paths. #127 (aradi)
Allow rendering of MathJax in HTTP aswell as HTTPS connections. #126 (haraldkl)
Regex for USE statements now recognizes "use :: module-name". Fixes #120 #123 (sliska314)
Sort page files and directories alphabetically. Fixes #121 #122 (lstagner)
Include the creation date and time in the footer #115 (p-vitt)