Back to Homepage of Kalle Rutanen
Remark is a Python library to generate html documentation for software libraries. Remark is documented with Remark, the results of which you are inspecting right now.
From the console (Windows, Linux, Unix, ...):
remark.py [options] inputDirectory outputDirectory [filesToCopy...]
See the installation instructions below.
For previous versions, see the release history.
This documentation uses MathML to display inlined mathematics. Unfortunately not all browsers support MathML natively, including Internet Explorer. In this case you will not be able to see the mathematical expressions at all. While there is a plug-in available (MathPlayer) for adding this capability to Internet Explorer, in our tests this combination crashed the browser when viewing these pages. According to Wikipedia, some major web-browsers that currently display MathML natively include Mozilla Firefox, Opera, and Camino. At this point we can't do anything else than to direct you to use these browsers to view these pages.
Remark 1.0, 1.1, and 1.2 were programmed under funding from the Finnish Foundation for Technology Promotion
Remark was preceded by a similar implementation
called LightMark programmed by Juho Hämäläinen.
The ideas gathered and tested in that implementation
was the basis on which Remark was built.
He should be attributed the idea of using
Markdown for writing the documentation.
| Implementation | Main features |
| Installation | Release history |
| License matters | User documentation |