当我在我的Rails应用程序根目录中运行rakedoc:app时，API文档是使用/doc/README_FOR_APP作为主页生成的。我想向该文件添加.rdoc扩展名，以便它在GitHub上正确呈现。更好的是，我想将它移动到应用程序根目录(/README.rdoc)。有没有办法通过修改包含的rake/rdoctask任务在我的Rakefile中执行此操作？是否有某个地方可以查找可以修改的主页文件的名称？还是我必须编写一个新的Rake任务？额外的问题:Rails应用程序的两个单独文件/README和/doc/README_FOR_APP背后的逻辑是什么？为什么不只有一个？
我喜欢使用Textile或Markdown为我的项目编写自述文件，但是当我生成RDoc时，自述文件被解释为RDoc并且看起来非常糟糕。有没有办法让RDoc通过RedCloth或BlueCloth而不是它自己的格式化程序运行文件？它可以配置为自动检测文件后缀的格式吗？(例如README.textile通过RedCloth运行，但README.mdown通过BlueCloth运行) 最佳答案 使用YARD直接代替RDoc将允许您包含Textile或Markdown文件，只要它们的文件后缀是合理的。我经常使用类似于以下Rake任务的东西:
我有一个客户端gem，我将通过rubygems分发业务客户端。Gem客户端有cca。十几个gem依赖项，当它被安装时，由于为每个gem生成rdoc和ri，安装它需要很长时间。客户是商业用户，他们对rdoc/ri没有用处，我正在寻找一种通过.gemspec或Gemfile禁用它的方法。我熟悉利用系统文件.gemrc禁用rdoc/ri的解决方案。但这是NotAcceptable解决方案，因为我希望我的安装像键入一样简单:gem安装foo 最佳答案 你可以使用post-installmessage解释他们可以通过运行@shime建
我正在将我维护的rubygem从RDoc切换到YARD文档。但是，代码中有一些关键注释只需要保留在代码中，不应出现在文档中。例如:###SomeClassdocumentationhere.#--#CRITICALcommentthatshouldbeinthecodebutnotinthedocumentation,#andmustbeatthisparticularspotinthecode.#++#moredocumentationthatfollowsthecriticalcommentblock,butthispart#shouldbeinthegenerateddocu
我有Ubuntu11.10，正在使用rvm和ruby1.9.2。我完全按照这个来安装Ruby:http://blog.sudobits.com/2011/10/27/how-to-install-ruby-on-rails-in-ubuntu-11-10/我用生成文档rvmdocsgenerate这似乎适用于一次性终端session，但一旦我退出并重新开始，我必须再次生成文档，否则我会收到NothingisKnown错误这需要很长时间，所以我宁愿不必在每次启动终端session时都生成文档。我可以做些什么来使文档永久可用吗？肯定有与此类似的问题——但我对生成文档或使用它们没有问题，
是否可以在Rails项目中使用readme.md文件并让rdoc在主页上使用它？我尝试按如下方式设置我的rake任务，但生成的index.html页面有一个占位符语句。如果我更改为README.rdoc，它会按预期工作，因为包含文件的内容。我也在尝试使用tomdoc，我猜这可能会使事情复杂化，不确定。RDoc::Task.new:rdocdo|rdoc|rdoc.main="README.md"rdoc.rdoc_files.include("README.md","doc/*.rdoc","app/**/*.rb","lib/**/*.rb","config/**/*.rb")rdo
我有一个这样记录的函数:###Searchesforstreetnamesinthelocaladdressdatabase.Returnsalist#ofstrings,orinvokestheblockforeachresult.##@param[String,Hash]query##Canbe:##-Asearchstringwithoptinalwildcards.Examples:#-"Bærumsv*"#-"Fornebuve_en"##@param[Integer]limit##Limitstheamountofresults.See{#search_street_add
我有一个从工厂函数创建的类，如下所示:Cake=MyProject.Struct(:type,:price)在Yard中，它只是与我的常量一起显示:Cake=Struct(:type,:price)Iwantittoshowupinthe"Classes:"list.Afterreadinguponthedocs,Iwasleadtobelievethatthiswouldwork:#@!parseclassCake;endCake=MyProject.Struct(:type,:price)但它确实没有任何改变。是否可以让Yard将动态创建的类记录为类？
我有一些没有ri/rdoc文件的gem，我想知道是否有安装此rdoc文件的方法。 最佳答案 编辑:Someoftheanswersonthisquestionmayhelpyou.旧:Thissiteseemstohaveyouranswer.例子:gemrdocrake--version0.5.4 关于ruby-如何安装已安装的gem的RDOC？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.com/qu
我正在使用class_eval来更简洁地定义一堆重复的方法，像这样:%w{greasychunkybacon}.product(%w{flyingskypoodle}).eachdo|a,b|class_eval"def#{a}_#{b};do_something;end"end我希望所有生成的方法都包含在RDoc文档中。是否有RDoc指令“手动”将方法添加到类的方法列表中？我找不到。 最佳答案 请参阅RDocdocumentationforRDoc::Parser::Ruby中有关元编程方法和隐藏方法和属性的部分.在你的情况下，你
