Как добавить страницу в RDoc?

Question

Noob здесь пытается выяснить простую задачу добавления страницы в мою документацию RDoc. Если я сделаю rake doc:app и просмотрю страницу, тогда появится боковая панель с надписью «Страницы» с README_FOR_APP. Все, что я хочу сделать, это создать страницу под названием «Cheatsheet», которая появится в разделе «Страницы». Как создать страницу документации и сообщить RDoc о включении новой страницы?

Answer 1

IMO немного запутанный. Вот ссылки, которые я использовал:

• http://rake.rubyforge.org/classes/Rake/RDocTask.html
• How to Rename or Move Rails's README_FOR_APP

Nutshell версия:

Возьмите "приложение" задачу из ваших рельсов библиотеки каталогов, например, я тестировался с помощью:

~/.rvm/gems/ruby-1.9.2-p0@foo/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 задание подберет его.