我正在制作一个rubygem。 RDoc非常适合记录类方法和字段，但是我希望有一个“概述页面”，它具有模块的基本架构概要，类如何与它相关等。将代码嵌入到代码中似乎不正确每次加载文件时，解释器必须解析它。
在rubygem中包含此类文档是否正确？如果是这样，如何在rubygem中包含这样的非代码嵌入式文档？
此外，是否安装了rubygem，构建了一个在运行时使用的“预编译”缓存版本，这使得加载速度更快，因此大量的文档不是问题？不是吗？
答案 0 :(得分：0)
有时很难在文档生成器上搜索文档：）
但答案是你可以控制rdoc的行为并指定在gemspec对象中构建和安装gem时要包含的额外文件：
http://guides.rubygems.org/specification-reference/
spec.extra_rdoc_files = ['README'，'doc / user-guide.txt']
spec.rdoc_options＆lt;＆lt; '--title'＆lt;＆lt; 'Rake - Ruby Make'＆lt;＆lt; '--main'＆lt;＆lt; 'README'＆lt;＆lt; '--line号码'