Source code documentation

Since everyone loves a properly documented code (we sure do!), we added extensive docstrings to the internal source codes of both Legolas and the post-processing framework Pylbo. These are in turn used to automatically generate documentation.

However, since Legolas is written in Fortran and Pylbo is written in Python, it is difficult to decently document both codes using the same tool. That’s why we opted to use language-specific tools: FORD for the generated Legolas documentation, and Sphinx for the generated Pylbo documentation.

Both of these have their own generated webpages, accessible through this page using the buttons below. These are generated completely automatic and are hence kept independent of the main website. We really want to keep these as up-to-date as possible, so if you notice anything missing please let us know, preferably through an issue on GitHub. Also tag it with the yellow-green #docs label while you’re at it, so we can easily keep track of them!

Legolas docs Pylbo docs