Skip to content

Release v2.0.2

Choose a tag to compare

@johan162 johan162 released this 12 Sep 21:16
· 17 commits to main since this release

Summary

Focus for this release is significantly improved documentation.

Details

The documentation is now generated with Doxygen and is available both in HTML and PDF format
and is included in the distribution.

In addition, the documentation is available on-line in github wiki as:

  1. (HTML) mptools User guide
  2. (PDF) mptools User guide

As is praxis the source for the documentation is not included in the distributed tar-ball
only the resulted generated docs. This is because generating the docs is a build time pipeline requiring
special tools. The repo (of course) contains the full source but not any generated documentation
as a matter of policy.

Internal changes

New docs directory

A new directory docs with a Doxygen-setup have been created as well as a new Makefile
to run the documentation pipeline.
The pipeline is run from the top-level Makefile recursively given the top-level target docs.

Note: This will only create the HTML version (on purpose) since In order to create the PDF
version a full LaTeX installation must exist,

To create the PDF version of the user guide first move to the docs directory and run make pdf
(or stay in the top-level and run make -C docs pdf.

Other updates

  • The script files have been updated with new Doxygen comments

 

Full Changelog: v2.0.1...v2.0.2