Math markup in code documentation?

[schwehr]

Done any one have a way (and examples) of how to do math markups in the
docstrings of function and class definitions such that the equations
get typeset in the generated html documentation? I'll take any markup
system that'll do the job... MathML or LaTeX possible?

I'd like to start doing a better job of documenting the equations and
units being used in pmag-py (http://schwehr.org/software/pmag) for
processing paleomagnetic data.

AND on the longest of long shots... anyone have any opensource python
for matching bulk composition to minerals? Nah, I thought not.

Thanks!
-kurt

 

[Dennis Benzinger]

Done any one have a way (and examples) of how to do math markups in the
docstrings of function and class definitions such that the equations
get typeset in the generated html documentation? I'll take any markup
system that'll do the job... MathML or LaTeX possible?
[...]

Try Doxygen: http://www.doxygen.org

Examples of formulas are here:
http://www.stack.nl/~dimitri/doxygen/formulas.html

Doxygen has the advantage that you can use it for a variety of
programming languages.

Bye,
Dennis

 

[Terry Hancock]

Done any one have a way (and examples) of how to do math markups in the
docstrings of function and class definitions such that the equations
get typeset in the generated html documentation? I'll take any markup
system that'll do the job... MathML or LaTeX possible?

epydoc has some capacity for rendering equations and math symbols. I'm
not sure if it supports the full range of TeX expressions.

 

[schwehr]

Awesome!!! When did doxygen start supporting python? I was really
into doxygen last year, but stopped using it when I started doing a lot
of coding in python.

Thanks!!!!
-kurt