Documentation dans les grails

Question

Je veux générer quelque chose comme http://grails.org/doc/latest/ pour mon projet de gravier.

J'ai essayé Grails doc, mais il n'organise pas le projet dans Taglibs, etc.

Je veux quelque chose à récupérer facilement l'taglib pour un espace de noms donné.

Voir aussi plus clairement l'état global de la documentation du projet. Savez-vous s'il existe un plugin pour cette solution de contournement ou n'importe quelle solution de contournement?

merci à l'avance

Answer 1

Il n'y a rien que je connaisse qui génère automatiquement ce. Tout ce qui est sous src/docs/guide est inclus dans la documentation principale, et les fichiers sous src/docs/ref sont inclus dans le cadre de gauche. Les sous-répertoires sous src/docs/ref créent des sous-sections.

Voir la structure du dossier source Grails doc à http://github.com/grails/grails-doc/tree/master/src/ pour la façon dont les principaux documents de travail, et ma source de plugin doc à http://github.com/grails-plugins/grails-spring-security-core/tree/master/src/docs/ pour un exemple plus petit, qui génère http://burtbeckwith.github.com/grails-spring-security-core/docs/manual/

Answer 2

J'ai récemment contribué un plug-in "Grails Runtime Docs" (http://grails.org/plugin/grails-runtime-docs) aux grails qui est conscient de Grails. Il organise les artefacts de grails et catégorise les classes en contrôleurs, commandes, domaines, services et bibliothèques de balises. Le plugin génère une documentation groovy à partir de l'exécution afin d'inclure également les méthodes dynamiques, en ajoutant "Dynamic Method Summary" & "Dynamic Method Detail" dans les documents html générés, qui fournissent leurs informations source.