commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sebb <seb...@gmail.com>
Subject Re: [BeanUtils] moving the documentation from javadoc to website
Date Tue, 14 Sep 2010 16:28:08 GMT
On 14 September 2010 00:18, Phil Steitz <phil.steitz@gmail.com> wrote:
> On 9/13/10 7:02 AM, sebb wrote:
>>
>> On 13 September 2010 11:12, Niall Pemberton<niall.pemberton@gmail.com>
>>  wrote:
>>>
>>> On Mon, Sep 13, 2010 at 11:05 AM, sebb<sebbaz@gmail.com>  wrote:
>>>>
>>>> I think it's important to have documentation that can be used offline.
>>>>
>>>> This applies to the Javadoc which should be in Maven and in the binary
>>>> jar.
>>>> If there is any additional user documentation it should ideally be
>>>> available in downloadable form as well.
>>>>
>>>> For example, as is done with Commons Math - the binary archive
>>>> includes Javadoc and User docs.
>>>
>>> Many components used to ship the m2 site in the binary distro. From
>>> memory, when we moved to m2 the links were broken for the distributed
>>> site (I believe m2 converted absolute urls to relative ones) - so we
>>> stopped including the site in the disto. I don't know if this is now
>>> resolved with the current version of m2 and the plugins we use.
>>
>> AFAICT Math 2.1 was built withe M2 (parent pom 14) and the user
>> documentation links seem to work OK.
>>
>> Math does not include the whole site, just the user guide.
>>
>> This is included by bin.xml.
>
> Unfortunately, I had to do some ugly hacks to get a site including only the
> UserGuide.  You can see this here:
> http://svn.apache.org/repos/asf/commons/proper/math/trunk/math-RC.sh
> The hacked pom and other resources are in math/siteMods

I see.

It ought to be possible to use Maven to create both the site and a
stand-alone document from the same source.

The stand-alone docs don't need to look like a cut-down web-site - a
PDF file would be as good.

I had some success playing with the Maven Doxia plugin
(doxia:render-books), but have not got it working fully yet.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message