Comment peut-on inclure de la documentation distribuable non codée (rdoc) sur Rubygem?

Question

Je fais un rubygem. RDoc est idéal pour documenter les méthodes et les champs de classes mais je veux avoir une "page de vue d'ensemble" qui a un résumé de l'architecture de base du module comment les classes s'y rapportent etc. Il ne semble pas correct d'avoir cela incorporé dans le code chose que l'interprète doit analyser à chaque fois qu'il charge les fichiers.

Est-il correct d'inclure ce genre de documentation dans un rubygem? Si oui, comment peut-on inclure ces docs non-code incorporés dans un rubygem?

De même, est-ce que l'installation d'un rubygem permet de créer une version de cache «pré-compilée» utilisée à l'exécution qui accélère le chargement de sorte que les documents volumineux ne posent pas problème? ou pas?

Answer 1

parfois difficile de rechercher des documents sur un générateur de documentation :)

Mais la réponse est que vous pouvez contrôler le comportement de rdoc et spécifier des fichiers supplémentaires à inclure lors de la construction et l'installation d'un petit bijou dans l'objet gemspec:

http://guides.rubygems.org/specification-reference/

spec.extra_rdoc_files = [ 'README', 'doc/user-guide.txt']

spec.rdoc_options < < « --titl e » < < 'Rake - Ruby Make' < < '--main' < < 'README' < < '--line numéros'