You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mahout.apache.org by "Dmitriy Lyubimov (JIRA)" <ji...@apache.org> on 2013/04/29 22:08:15 UTC
[jira] [Commented] (MAHOUT-1198) Allow Latex in javadox
[ https://issues.apache.org/jira/browse/MAHOUT-1198?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13644810#comment-13644810 ]
Dmitriy Lyubimov commented on MAHOUT-1198:
------------------------------------------
But this will work only for as long as mathjax service is up ? if it is down or moved, it will get unreadable?
> Allow Latex in javadox
> ----------------------
>
> Key: MAHOUT-1198
> URL: https://issues.apache.org/jira/browse/MAHOUT-1198
> Project: Mahout
> Issue Type: Bug
> Reporter: Ted Dunning
>
> We are headed into a release (hopefully) and now would be a nice time to add the capability to generate javadocs with embedded latex.
> Following a hint from commons math, I tested a way to inject mathjax into the header of the resulting web-site and got good results (see http://tdunning.github.io/bandit-ranking/ especially docs for GammaNormalDistribution and BetaBinomialDistribution.
> The basic idea is that we need to add the following config to the javadocs plugin:
> {quote}
> <configuration>
> <additionalparam>-header '<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML"> </script>'</additionalparam>
> </configuration>
> {quote}
> Having done this, \[ \] and \( \) can be used to embed latex equations in the javadocs.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira