如何將頁面添加到RDoc？

Noob這裏試圖找出添加頁面到我的RDoc文檔的簡單任務。如果我的電子郵件地址爲rake doc:app並查看頁面，則會顯示一個標題爲「Pages」的邊欄，其中列出了README_FOR_APP。我想要做的就是創建一個名爲「Cheatsheet」的頁面，它將出現在「Pages」下。如何創建文檔頁面並告訴RDoc包含新頁面？如何將頁面添加到RDoc？

來源

2012-05-13 happybot

海事組織它有點複雜。下面是我使用的引用：

果殼版本：

從你的軌道庫目錄中的「應用程序」的任務，比如我測試使用：

~/.rvm/gems/[email protected]/gems/railties-3.0.9/lib/rails/tasks/documentation.rake

您需要的飾品照片（約）是這樣的：

namespace :doc do 
    def gem_path(gem_name) 
    path = $LOAD_PATH.grep(/#{gem_name}[\w.-]*\/lib$/).first 
    yield File.dirname(path) if path 
    end 

    RDocTaskWithoutDescriptions.new("app2") { |rdoc| 
    rdoc.rdoc_dir = 'doc/app' 
    rdoc.template = ENV['template'] if ENV['template'] 
    rdoc.title = ENV['title'] || "Rails Application Documentation" 
    rdoc.options << '--line-numbers' << '--inline-source' 
    rdoc.options << '--charset' << 'utf-8' 
    rdoc.rdoc_files.include('doc/*_FOR_APP') # Modified this line 
    rdoc.rdoc_files.include('app/**/*.rb') 
    rdoc.rdoc_files.include('lib/**/*.rb') 
    } 
end

將這個應用程式的lib/tasks目錄中.rake文件，例如，doc2.rake。

如果要保留原始文件，請更新任務名稱，例如"app2"。

將"doc/README_FOR_APP"字符串更新爲更寬的模式，或添加新文件進行處理。

創建doc/Cheatsheet_FOR_APP和新的rake doc:app2任務將會啓動它。

來源

2012-05-13 23:39:15

如何將頁面添加到RDoc？

回答

相關問題