Math in Documentation
Hi,
when one builds the documentation via bash build_documentation.sh one receives a significant amount of WARNING and ERROR messages. Some of those arise from math formulas that are entered in a fashion that sphinx mistakes for something completely different. Take as an example the
following snippet from forms_facets.py:
'inner': coupling of element unknowns with themselves (both, v and w restricted to E1)
- 0.5 * \int_e J_v^{-\top} \nabla v \cdot n w
- 0.5 * \int_e J_w^{-\top} \nabla w \cdot n v
+ \frac{\sigma}{\meas(e)^\beta} \int_e v w
which sphinx interprets as a bullet list, producing this warning:
hog/forms_facets.py:docstring of hog.forms_facets.diffusion_sip_facet:15: WARNING: Bullet list ends without a blank line; unexpected unindent.
and the following rendering:
which is, of course, bogus. Using .. math:: and brushing up the LaTeX source one could obtain instead:
I could do this, but am not very well versed in the details of formatting docstrings, yet. So I would need some help.
Cheers
Marcus

