incubator-general mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Bhuvaneswaran A <bhuvaneswa...@gmail.com>
Subject Re: Publishing api docs for Subversion
Date Fri, 04 Dec 2009 10:19:48 GMT
On Fri, Dec 4, 2009 at 2:12 PM, Jukka Zitting <jukka.zitting@gmail.com> wrote:
> Some Apache projects are now using Hudson builds to generate their web
> sites from sources stored in svn. The generated site is periodically
> rsynced to the correct place people.apache.org. This setup is still a
> bit experimental but should cover your needs pretty well.

Thanks for sharing your views, Jukka.

Thinking deeper into this task, the Hudson has a inbuilt feature to
publish html content if placed in userContent folder. The javadoc
publishing capability is already present in Hudson. Taking advantage
of both these Hudson features, I'm thinking a) configure the job(s) to
generate doxygen and javadoc documentation. b) create a link to this
document to userContent. With this setup, the documentation can be
made available here:

doxygen: http://hudson.zones.apache.org/hudson/userContent/subversion/doxygen/index.html
javadoc: http://hudson.zones.apache.org/hudson/userContent/subversion/javadoc/index.html

We may configure this job to run on daily basis.

AFAIK, in the past we did not publish doxygen/javadoc for stable
releases in Subversion project. If we had to so, we may place them in
svn under site/ directory corresponding to that release. The
documentation for trunk aka. on going changes can be made available in
the above url which we may link it from our home page, if need be.

To publish document in this fashion, all we need to do is create
Hudson job(s) appropriately. I'll propose this plan to our project
team and do the setup accordingly.

Thank you!

-- 
Regards,
Bhuvaneswaran A
www.livecipher.com
GPG: 0x7A13E5B0

---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org


Mime
View raw message