river-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Peter Firmstone <j...@zeus.net.au>
Subject Re: Website, docuemntation links, and river/src-doc/static/index.html
Date Mon, 13 Dec 2010 00:56:49 GMT
The standards and release notes contain links to the build generated 
javadoc, built from java source.

Is it possible to generate javadoc in the markdown format from the 
source code?  Or can markdown generate javadoc?

If we could, then we could pull the website from it's svn path, and pull 
the standards, release notes and javadoc from river/trunk.

This looks interesting: http://code.google.com/p/markdown-doclet/

I think we currently access the javadoc from hudson builds for our 
website, but this isn't suitable for our release.  It would be nice if 
we could satisfy the website and the release with one source, since this 
reduces maintenance.

I'm not sure what the way forward is at the moment, it requires some 
more thought.



Sim IJskes - QCG wrote:
> On 12/12/2010 12:12 PM, Peter Firmstone wrote:
>> Ok, sounds logical, when you checkout and build River, all the
>> documentation is build able from ant, which is then included in the
>> build that I release, so the copy we build for the website should also
>> be buildable from ant? Does this mean we need a new tool in our lib's to
>> build the docs?
> Could be, yes. We could decide to include the docs in original 
> markdown format, or scrape them from the website, or convert them to 
> html by markdown. The only quick solutions that i see are include the 
> original mdtext files, or pull the converted mdtext files from the svn 
> repo that contains the website just before publishing (all html).
> Gr. Sim
> the chain is as follow for ASF CMS:
> mdtext in svn
> stage:
> convert to html
> store html in website repo
> checkout to staging website
> publish:
> copy html in website repo to other repo dir
> chechout to production website (all the mirrors)

View raw message