Tag: rdoc
如何使README_FOR_APP的内容出现在doc / app / index.html中
我想在doc/app/index.html出现doc/README_FOR_APP的内容，当我做rake doc:app 。 目前，内容是： 这是Rails应用程序文档的API文档。 要查看README_FOR_APP ，我必须单击左侧页面列表中的README_FOR_APP 。 我已经看过如何重命名或移动Rails的README_FOR_APP，但OP断言他已经看到了我想要的行为。 我正在使用rails 3.1.3。
为rails应用程序创建Rdoc
我想为我的rails（2.3.8）项目生成一个文档。 当我尝试 rake doc:rails rake doc:rerails 它为所有类创建文档，包括标准ruby类和供应商目录中的所有ruby文件（插件等）。 如何仅为ruby类，以下目录中的文件创建rdoc文档 app文件夹（所有模型，控制器和视图） 配置文件夹 lib文件夹
错误：’rake / rdoctask’已过时且不再受支持
出乎意料的是，我开始收到以下错误消息： (in /Users/me/.rvm/gems/ruby-1.9.3-p125@mysql2/gems/rails-0.9.5) rake aborted! ERROR: ‘rake/rdoctask’ is obsolete and no longer supported. Use ‘rdoc/task’ (available in RDoc 2.4.2+) instead. /Users/me/.rvm/gems/ruby-1.9.3-p125@mysql2/gems/rails-0.9.5/Rakefile:3:in `’ 当我做rails s（在我的开发环境终端–Mac Mountain Lion）。 这个应用程序正在生产中，所以我去了生产环境，做了一个捆绑显示，并修改了我的Gemfile，以对这些gems版本进行编码。 这就是我现在在我的本地开发环境中所产生的内容（产生错误消息的原因）。 actionmailer (3.2.3) actionpack (3.2.3) activemodel (3.2.3) activerecord (3.2.3) activeresource (3.2.3) activesupport (3.2.3) annotate (2.4.1.beta1) arel (3.0.2) bcrypt-ruby (3.0.1) bootstrap-datepicker-rails (0.6.15) bootstrap-sass (2.0.2) builder (3.0.4) bundler (1.1.3) coffee-rails […]
没有这样的文件加载 – rdoc / task
当我跑 rake db:create 我收到此错误 rake aborted! no such file to load — rdoc/task (See full trace by running task with –trace) 这是–trace /usr/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:36:in `gem_original_require’ /usr/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:36:in `require’ /home/tpeg/rails_apps/Test/Rakefile:8 /usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/rake_module.rb:25:in `load’ /usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/rake_module.rb:25:in `load_rakefile’ /usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:495:in `raw_load_rakefile’ /usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:78:in `load_rakefile’ /usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:129:in `standard_exception_handling’ /usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:77:in `load_rakefile’ /usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:61:in `run’ /usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:129:in `standard_exception_handling’ /usr/lib/ruby/gems/1.8/gems/rake-0.9.2/lib/rake/application.rb:59:in `run’ /usr/lib/ruby/gems/1.8/gems/rake-0.9.2/bin/rake:32 /usr/bin/rake:19:in `load’ /usr/bin/rake:19 我安装了rake 0.9.2和rdoc 3.11。 我在我的应用程序目录中运行这些命令。
Rails：如何解决’rake / rdoctask”已弃用’警告？
只是预警：我是铁杆菜鸟。 当我跑： rake db:migrate 我收到了这个弃用警告： WARNING: ‘require ‘rake/rdoctask” is deprecated. Please use ‘require ‘rdoc/task’ (in RDoc 2.4.2+)’ instead. at /Users/username/Code/rails/appname/rake/ruby/1.9.1/gems/rake-0.9.2.2/lib/rake/rdoctask.rb 我正在使用： Rails 3.0.1 耙0.9.2.2 RSpec 2.0.1 RDoc 3.12 如果我卸载rake 0.9.2.2并使用0.8.7没有警告，但我宁愿不把它算作解决方案。 谷歌搜索后，许多网站说我需要更新我的Rakefile中的一行（基本上需要’rake / rdoctask’来改变需要’rdoc / task’）。 但是，我的Rakefile看起来像这样： require File.expand_path(‘../config/application’, __FILE__) require ‘rake’ AppName::Application.load_tasks 没有要求替换的声明。 当我添加require’rdoc / task’时，它没有任何效果。 当我在项目中搜索已弃用的’rake / rdoctask’时，没有结果。 为什么rails抱怨？ 编辑：不确定是否重要，但这是我的gemfile： source ‘http://rubygems.org’ gem ‘rails’, […]
rdoc，darkfish和：call-seq：标签
我正在使用rdoc记录Ruby项目，我发现了darkfish rdoc格式化程序。 我非常喜欢它，但是:call-seq:标签不再有效。 相反，它将文字字符串:call-seq:放在文档中，然后将调用序列本身格式化为代码块。 我不想从我的代码中取出所有：call-seq：blocks，因为我的大部分文档都需要引用:call-seq: block中给出的实例名称和参数名称。 有没有其他人有这个问题？ 我该怎么办，是否有解决方法？ 我很确定:call-seq:标签在我使用默认格式化程序之前正在运行，但我无法确定，因为我无法弄清楚如何返回生成原始格式（调用rdoc与除了文件之外没有任何参数现在生成暗鱼输出，即使我删除了doc文件夹！）有谁知道如何解决这个问题？
为本地安装的gem生成RDOC
我正在努力为我最近感兴趣的一颗gem做出贡献 – 内斯塔。 开发人员在创建您可以找到的最轻，最最好的CMS之一方面做得很好，我想记录它。 我已经阅读了代码，并根据我的知识对一些方法进行了评论。 但是，我试图通过调用gem server在本地测试它，并在推送它之前查看我的机器上的更改。 我尝试过的事情： 手动编辑。 记录文件。 解雇了gem server 。 使用gem工具。 记录文件。 Ran gem rdoc nesta –rdoc 重启gem server 一切都无济于事。 请帮忙。 谢谢。
在rdoc中显示inheritance的方法
我有一个用Ruby编写的程序，它使用多级inheritance。 所有父类都实现了子类的对象将使用的方法，但是当我为我的程序生成rdoc时，子类的rdoc页面仅显示该特定类的方法，而不显示父类的方法。 有谁知道如何在rdoc中显示inheritance的类方法？ 我查看了rdoc文档和一些网站，但未能找到答案是否可行。
在Ruby中识别方法的＃约定的基本原理/历史是什么？
例如，我总是看到称为String#split ，但从来没有看过String.split ，这似乎更符合逻辑。 或者甚至可能是String::split ，因为你可以认为#split在String的命名空间中。 当假定/隐含类（ #split ）时，我甚至独自看过这个方法。 我知道这是在ri中识别方法的方式。 哪个先来？ 这是区分，例如，来自字段的方法？ 我也听说这有助于区分实例方法和类方法。 但这是从哪里开始的？
安装RDoc文档时出错：不兼容的编码正则表达式匹配
在过去一周，在一些gem安装或gem更新操作中，我收到了类似这样的错误： 错误：为sinatra-1.3.1生成文档时… MESSAGE：生成错误C：/RailsInstaller/Ruby1.9.2/lib/ruby/gems/1.9.1/doc/sinatra-1.3.1/rdoc/README_de_rdoc.html ：不兼容的编码regexp匹配（UTF-8 regexp与IBM437字符串）（Encoding :: CompatibilityError） 类似的： 错误：为rest-client-1.6.7生成文档时… MESSAGE：生成错误C：/RailsInstaller/Ruby1.9.2/lib/ruby/gems/1.9.1/doc/rest-client-1.6.7/rdoc /README_rdoc.html：不兼容的编码regexp匹配（UTF-8 regexp与IBM437字符串）（Encoding :: CompatibilityError） 可能还有一个地方。 我已经读过这篇文章，但是找不到我没写的代码和我无法控制的数据的解决方案。 知道如何解决这个问题吗？
