Generating RDOCs for locally installed gems

旧巷老猫 提交于 2019-12-12 18:09:21

问题


I am trying to contribute to a gem I recently took interest in - Nesta. The developer has done a great job in creating one of the lightest, thinest CMSs you can find and I want to document it. I have read through the code and commented on a few methods to the best of my knowledge.

However, I seek to test this out locally by calling gem server and seeing the changes on my machine before pushing it online.

Things I have tried:

  1. Manual edit.
    • Documented the file.
    • Fired up gem server.
  2. Using the gem tool.
    • Documented the file.
    • Ran gem rdoc nesta --rdoc
    • Restarted gem server

All to no avail. Please help.
Thank you.


回答1:


You can preview generated html pages without installing a modified version of the gem on your machine. Add this to nesta's Rakefile:

require 'rake/rdoctask'
Rake::RDocTask.new('doc') do |i|
  i.rdoc_files = FileList['lib/**/*']
end

and type rake doc. Then view generated html/index.html file.




回答2:


Are you sure you've installed the version that you've modified, not the original version?

If you've installed the modified version, but have forgotten to install the rdoc, see Can you install documentation for existing gems?



来源:https://stackoverflow.com/questions/5776491/generating-rdocs-for-locally-installed-gems

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!