You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Phil Steitz <ph...@gmail.com> on 2013/07/14 19:50:28 UTC
[math] Math-Jax in javadoc?
I think we have talked about this before but did not achieve
consensus or at least never got it set up. I am finishing the
javadoc for Kolmogorov-Smirnov tests (MATH-437) and would really
like to just embed Tex formulas in the class javadoc. I found that
just adding an additionalparmeter element to the javadoc plugin
config in the pom works to get MathJax configured. Then you just
use Tex escapes \( and \) for inline, \[ and \] for formulas. If
others are OK with this, I will open a JIRA to make the pom change
and document usage in the programmers guide.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [math] Math-Jax in javadoc?
Posted by Ted Dunning <te...@gmail.com>.
I am not sure that I tested with other than javadoc:javadoc.
I also don't think that Mahout uses the site target for generating javadocs
(at least not in continuous integration).
We are only now doing our first release since making the change so I can't
say how that is turning out just yet.
On Sun, Jul 14, 2013 at 10:01 PM, Phil Steitz <ph...@gmail.com> wrote:
> On 7/14/13 3:24 PM, Ted Dunning wrote:
> > We have adopted this in Mahout based on the suggestion I saw here.
> >
> > It works great.
>
> I just opened a ticket
> (https://issues.apache.org/jira/browse/MATH-1006) and attached a
> patch. For some reason, the maven site plugin does not pass the
> -header option through to the javadoc plugin. When I do "mvn
> javadoc:javadoc" it works; but "mvn site" does not bring the MathJax
> engine in. How did you guys get this to work in mahout? Thanks in
> advance.
>
> Phil
> >
> >
> >
> > On Sun, Jul 14, 2013 at 2:31 PM, Ajo Fod <aj...@gmail.com> wrote:
> >
> >> I like this idea too. I"m curious to know how it works.
> >>
> >> +1
> >>
> >>
> >> On Sun, Jul 14, 2013 at 11:35 AM, Thomas Neidhart <
> >> thomas.neidhart@gmail.com
> >>> wrote:
> >>> On 07/14/2013 07:50 PM, Phil Steitz wrote:
> >>>> I think we have talked about this before but did not achieve
> >>>> consensus or at least never got it set up. I am finishing the
> >>>> javadoc for Kolmogorov-Smirnov tests (MATH-437) and would really
> >>>> like to just embed Tex formulas in the class javadoc. I found that
> >>>> just adding an additionalparmeter element to the javadoc plugin
> >>>> config in the pom works to get MathJax configured. Then you just
> >>>> use Tex escapes \( and \) for inline, \[ and \] for formulas. If
> >>>> others are OK with this, I will open a JIRA to make the pom change
> >>>> and document usage in the programmers guide.
> >>> +1
> >>>
> >>> Thomas
> >>>
> >>> ---------------------------------------------------------------------
> >>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> >>> For additional commands, e-mail: dev-help@commons.apache.org
> >>>
> >>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>
Re: [math] Math-Jax in javadoc?
Posted by Phil Steitz <ph...@gmail.com>.
On 7/14/13 3:24 PM, Ted Dunning wrote:
> We have adopted this in Mahout based on the suggestion I saw here.
>
> It works great.
I just opened a ticket
(https://issues.apache.org/jira/browse/MATH-1006) and attached a
patch. For some reason, the maven site plugin does not pass the
-header option through to the javadoc plugin. When I do "mvn
javadoc:javadoc" it works; but "mvn site" does not bring the MathJax
engine in. How did you guys get this to work in mahout? Thanks in
advance.
Phil
>
>
>
> On Sun, Jul 14, 2013 at 2:31 PM, Ajo Fod <aj...@gmail.com> wrote:
>
>> I like this idea too. I"m curious to know how it works.
>>
>> +1
>>
>>
>> On Sun, Jul 14, 2013 at 11:35 AM, Thomas Neidhart <
>> thomas.neidhart@gmail.com
>>> wrote:
>>> On 07/14/2013 07:50 PM, Phil Steitz wrote:
>>>> I think we have talked about this before but did not achieve
>>>> consensus or at least never got it set up. I am finishing the
>>>> javadoc for Kolmogorov-Smirnov tests (MATH-437) and would really
>>>> like to just embed Tex formulas in the class javadoc. I found that
>>>> just adding an additionalparmeter element to the javadoc plugin
>>>> config in the pom works to get MathJax configured. Then you just
>>>> use Tex escapes \( and \) for inline, \[ and \] for formulas. If
>>>> others are OK with this, I will open a JIRA to make the pom change
>>>> and document usage in the programmers guide.
>>> +1
>>>
>>> Thomas
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>
>>>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [math] Math-Jax in javadoc?
Posted by Ted Dunning <te...@gmail.com>.
We have adopted this in Mahout based on the suggestion I saw here.
It works great.
On Sun, Jul 14, 2013 at 2:31 PM, Ajo Fod <aj...@gmail.com> wrote:
> I like this idea too. I"m curious to know how it works.
>
> +1
>
>
> On Sun, Jul 14, 2013 at 11:35 AM, Thomas Neidhart <
> thomas.neidhart@gmail.com
> > wrote:
>
> > On 07/14/2013 07:50 PM, Phil Steitz wrote:
> > > I think we have talked about this before but did not achieve
> > > consensus or at least never got it set up. I am finishing the
> > > javadoc for Kolmogorov-Smirnov tests (MATH-437) and would really
> > > like to just embed Tex formulas in the class javadoc. I found that
> > > just adding an additionalparmeter element to the javadoc plugin
> > > config in the pom works to get MathJax configured. Then you just
> > > use Tex escapes \( and \) for inline, \[ and \] for formulas. If
> > > others are OK with this, I will open a JIRA to make the pom change
> > > and document usage in the programmers guide.
> >
> > +1
> >
> > Thomas
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > For additional commands, e-mail: dev-help@commons.apache.org
> >
> >
>
Re: [math] Math-Jax in javadoc?
Posted by Ajo Fod <aj...@gmail.com>.
I like this idea too. I"m curious to know how it works.
+1
On Sun, Jul 14, 2013 at 11:35 AM, Thomas Neidhart <thomas.neidhart@gmail.com
> wrote:
> On 07/14/2013 07:50 PM, Phil Steitz wrote:
> > I think we have talked about this before but did not achieve
> > consensus or at least never got it set up. I am finishing the
> > javadoc for Kolmogorov-Smirnov tests (MATH-437) and would really
> > like to just embed Tex formulas in the class javadoc. I found that
> > just adding an additionalparmeter element to the javadoc plugin
> > config in the pom works to get MathJax configured. Then you just
> > use Tex escapes \( and \) for inline, \[ and \] for formulas. If
> > others are OK with this, I will open a JIRA to make the pom change
> > and document usage in the programmers guide.
>
> +1
>
> Thomas
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>
Re: [math] Math-Jax in javadoc?
Posted by Thomas Neidhart <th...@gmail.com>.
On 07/14/2013 07:50 PM, Phil Steitz wrote:
> I think we have talked about this before but did not achieve
> consensus or at least never got it set up. I am finishing the
> javadoc for Kolmogorov-Smirnov tests (MATH-437) and would really
> like to just embed Tex formulas in the class javadoc. I found that
> just adding an additionalparmeter element to the javadoc plugin
> config in the pom works to get MathJax configured. Then you just
> use Tex escapes \( and \) for inline, \[ and \] for formulas. If
> others are OK with this, I will open a JIRA to make the pom change
> and document usage in the programmers guide.
+1
Thomas
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [math] Math-Jax in javadoc?
Posted by Luc Maisonobe <Lu...@free.fr>.
Le 14/07/2013 19:50, Phil Steitz a écrit :
> I think we have talked about this before but did not achieve
> consensus or at least never got it set up. I am finishing the
> javadoc for Kolmogorov-Smirnov tests (MATH-437) and would really
> like to just embed Tex formulas in the class javadoc. I found that
> just adding an additionalparmeter element to the javadoc plugin
> config in the pom works to get MathJax configured. Then you just
> use Tex escapes \( and \) for inline, \[ and \] for formulas. If
> others are OK with this, I will open a JIRA to make the pom change
> and document usage in the programmers guide.
Big +1!
Luc
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org