[ETCH-14] Design and provide example of using forrest to deploy etch documentation

• Type: New Feature
• Status: Closed
• Priority: Major
• Resolution: Won't Fix
• Fix Version/s: 1.2
• Component/s: build, distribution, documentation
• Assignee: Dr. Holger Grandy
• Reporter: Robert Scott Comer
• Created: 18/Nov/08 18:54
• Updated: 03/Jan/12 12:41
• Resolved: 21/Jan/11 19:05

Description

currently etch documentation is static wiki pages. we want to have etch documentation site built from sources in the svn repo, so that

1) etch documentation is versioned by release
2) current documentation is available as part of distribution (or perhaps, optional with dist).
3) apache forrest is used to generate said documentation as part of the build process in a variety of formats and distribution modes (pdf, html, wiki, whatever).

this item is about setting up the mechanisms and an example doc to accomplish this. follow on projects will actually convert other etch documents to use the same mechanism. the example doc can be anything, but a reasonable choice is the java binding user's guide or the compiler user's guide.