Releases: Fortran-FOSS-Programmers/ford
Version 3.0.2
Fixed bug in link to a single source file in the main menu, if the file name contained an uppercase letter.
Version 3.0.1
Fixed errors when documentation followed alternative documentation. Also added checks to ensure that none of the docmarks are the same. This was supposed to be in the previous release, but was overlooked.
Version 3.0.0
- Added option to exclude contents of directories
- Fixed a bug in creating output files in Windows
- Now preprocesses code from files whose extensions indicate that this is necessary, prior
to extracting documentation. This can be
deactivated. The
user can also specify which
macros
should be provided to the preprocessor. - Change the meta-data settings "deprecated" and "warn" so that their value now needs to be "true"
in order to have any effect. - predocmark, docmark_alt, and predocmark_alt now have the default values of
>
,*
, and#
,
respectively. - Improved support for parsing type-bound procedures.
Version 2.1.0
- Added support for linking
to other parts of the documentation. - Introduced option to include a procedure's, derived type's, or programs's
syntax-highlighted source code at the bottom of its documentation page.
Can be specified globally
and overridden
for specific items. - Added option to change what will be displayed for a particular portion of
a project. Also added a 'none' option to
display settings,
causing all contents of an item to be hidden. - Created new way of specifying documentation. This allows a special docmark
to be designated which indicates that all comments in the following block
should be counted as documentation. This can apply for comments
before
or after
whatever item is to be documented.
Version 2.0.0
Following changes and improvements were implemented:
- Altered the CLI so that the Python argparse help message is more accurate
- Added support for extra variable types (useful when software uses certain libraries)
- Fixed handling of abstract interfaces, so that they are now treated as distinct from normal
interfaces - Added ability to produces links to abstract interfaces when being used to declare a procedure pointer
- Reworked internal treatment of interfaces in general
- Added support for multiple directories containing source files
- Improved checking if
project_dir
withinoutput_dir
- Added
|url|
and|media|
macros - Added ability to produce a page hierarchy, not linked to any particular source code
- Added ability to recognize implicitly declared arguments
- Added F90, F95, F03, F08 to list of default extensions to scan
Version 1.1.0
Added support for Python3. Also fixed a regression whereby FORD was evaluating paths for included files relative to the directory from which it was run, rather than relative to the location of the project file. Finally, added the ability to check code version from the command-line.
Version 1.0.1
FORD was crashing when processing abstract interfaces in some circumstances, due to a bug. This has now been fixed.
Version 1.0.0
This release represent a stable API and the adoption of semantic versioning. In this release there is the new ability to specify documentation preceding the code which it is documenting (thanks to mrestelli for contributing that improvement). While doing so he also caught a few small bugs which could have caused problems when people are using something other than the default !! to signify documentation.
Version 0.5
Various bug fixes. Also a change to the API (hence why the new version isn't just a patch)--sorry about that.
- Fixed a problem in reader.py which caused it to split lines even if
semi-colons were within strings. - Fixed conflicts between including Markdown files in documentation and any
other syntax (particularly that found in code fragments). However, this
required breaking the API, as the syntax for including a file is now
{! filename !}
. - Fixed a bug whereby if documentation lacks meta-data but has a colon in
the first line it would cause an error (as Markdown would try to interpret
that as meta-data).
Version 0.4
The first version of this code to be made available on PyPI. This required some modifications to bring it more inline with the typical Python style (although some issues remaine here). There is also the new feature which allows you to include the contents of other Markdown files in your documentation. Additionally, I have spun off the markdown-include functionality to its own module and made it a dependency on PyPI.