Rake Documentation

Question

I want to create something like http://grails.org/doc/latest/ for my grails project.

I tried grails doc but it does not organize the project in Taglibs etc.

I need something easy to get taglib for a given namespace.

Also more clearly see the global status of project documentation.

Do you know if a plugin exists for this or any workaround?

early

Answer 1

Nothing that I know automatically generates this. Everything in the src / docs / guide section is included in the main documentation, and the files in src / docs / ref are included in the left frame. Subdirectories in src / docs / ref create subsections.

See the source folder structure of the Grails source document at http://github.com/grails/grails-doc/tree/master/src/ for how the main documents work, and my plugin document source at http://github.com / grails-plugins / grails-spring-security-core / tree / master / src / docs / for a smaller example that generates http://burtbeckwith.github.com/grails-spring-security-core/docs/manual/

Answer 2

I recently added the Grails Runtime Docs plugin ( http://grails.org/plugin/grails-runtime-docs ) to grails that Grails knows. It organizes grails artifacts and classifies classes into controllers, teams, domains, services, and tag libraries. The plugin generates groovy documentation from the runtime to include dynamic methods by adding a "Dynamic Method Summary" and a "Detailed Dynamic Method" to the generated html documents that provide their source information.