You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mahout.apache.org by "Ted Dunning (JIRA)" <ji...@apache.org> on 2013/04/29 21:42:16 UTC

[jira] [Created] (MAHOUT-1198) Allow Latex in javadox

Ted Dunning created MAHOUT-1198:
-----------------------------------

             Summary: 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 &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

Re: [jira] [Created] (MAHOUT-1198) Allow Latex in javadox

Posted by Robin Anil <ro...@gmail.com>.
This is pretty cool!

Robin Anil | Software Engineer | +1 312 869 2602 | Google Inc.


On Mon, Apr 29, 2013 at 2:42 PM, Ted Dunning (JIRA) <ji...@apache.org> wrote:

> Ted Dunning created MAHOUT-1198:
> -----------------------------------
>
>              Summary: 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 &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
>