The purpose of the libraries in this package is purely educational. Thus their documentation needs to be improved. Haddock is not such a good choice for this, since the API does not play such an important role as a code walk-through would. Literate-style documentation is a much better option.
The documentation should generate
HTML pages (to be published in the forsyde-shallow web site)
LaTeX-PDF
So far a good and flexible frontend for literate code seems to be Org mode.
This repo should NOT be polluted by documentation resources (images, scripts, style files), since the users are interested only in the ForSyDe code. These resources should be in an own private repository.
The purpose of the libraries in this package is purely educational. Thus their documentation needs to be improved. Haddock is not such a good choice for this, since the API does not play such an important role as a code walk-through would. Literate-style documentation is a much better option.
The documentation should generate
So far a good and flexible frontend for literate code seems to be Org mode.
This repo should NOT be polluted by documentation resources (images, scripts, style files), since the users are interested only in the ForSyDe code. These resources should be in an own private repository.