mahout-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Suneel Marthi (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (MAHOUT-1198) Allow Latex in javadox
Date Thu, 25 Jul 2013 12:17:51 GMT

     [ https://issues.apache.org/jira/browse/MAHOUT-1198?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Suneel Marthi updated MAHOUT-1198:
----------------------------------

    Affects Version/s: 0.7
        Fix Version/s: 0.8
    
> Allow Latex in javadox
> ----------------------
>
>                 Key: MAHOUT-1198
>                 URL: https://issues.apache.org/jira/browse/MAHOUT-1198
>             Project: Mahout
>          Issue Type: Bug
>    Affects Versions: 0.7
>            Reporter: Ted Dunning
>             Fix For: 0.8
>
>
> 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 &apos;&lt;script type=&quot;text/javascript&quot;
src=&quot;http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML&quot;&gt;
&lt;/script&gt;&apos;</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

Mime
View raw message