By using this site, you agree to our updated Privacy Policy and our Terms of Use. Manage your Cookies Settings.
439,932 Members | 1,944 Online
Bytes IT Community
+ Ask a Question
Need help? Post your question and get tips & solutions from a community of 439,932 IT Pros & Developers. It's quick & easy.

Math markup in code documentation?

P: n/a
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

Oct 25 '05 #1
Share this Question
Share on Google+
3 Replies


P: n/a
On Tuesday 25 October 2005 09:38 am, sc*****@gmail.com wrote:
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.

--
Terry Hancock ( hancock at anansispaceworks.com )
Anansi Spaceworks http://www.anansispaceworks.com

Oct 25 '05 #2

P: n/a
sc*****@gmail.com schrieb:
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
Oct 25 '05 #3

P: n/a
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

Oct 25 '05 #4

This discussion thread is closed

Replies have been disabled for this discussion.