This fixes lots of formatting errors in our doc strings. Spinx now runs through without any serious errors.
Closes #335
Closes #336
Some comments for future reference:
References, e.g. [xyz] in doc strings need to be unique, therefore I changed our numbering [1] to letters [KOL2012]_
pylance (which shows the doc string if you hover over the function name in vs code) does not support latex formatting: https://github.com/microsoft/vscode/issues/168100. Therefore inline math using :math:'some nice latex' works better than using .. math:: some nice latex. vs code still does not render it correctly but at least it removes :math: and displays "some nice latex" as a differently formatted string.
Please always check that your doc strings are actually displayed as you think they will be displayed, e.g. having two separate lines after Returns leads to a list with bullet points.
This fixes lots of formatting errors in our doc strings. Spinx now runs through without any serious errors.
Closes #335 Closes #336
Some comments for future reference:
:math:'some nice latex'
works better than using.. math:: some nice latex
. vs code still does not render it correctly but at least it removes :math: and displays "some nice latex" as a differently formatted string.Returns
leads to a list with bullet points.