RDoc에 페이지를 추가하는 방법은 무엇입니까?

Noob은 RDoc 문서에 페이지를 추가하는 간단한 작업을 알아 내려고합니다. rake doc:app을 수행하고 페이지를 볼 경우 "페이지"에 README_FOR_APP가 나열된 사이드 바가 있습니다. 내가하고 싶은 일은 "페이지"아래에 나타날 "Cheatsheet"라는 페이지를 만드는 것입니다. 문서 페이지를 만들고 RDoc에 새 페이지를 포함하도록 알려면 어떻게해야합니까?RDoc에 페이지를 추가하는 방법은 무엇입니까?

출처

2012-05-13 happybot

IMO 다소 복잡합니다. 저는 여기에 사용되는 참조는 다음과 같습니다

요컨대 버전 :

예를 들어 내가 사용하여 테스트, 당신의 레일 라이브러리 디렉토리에서 "응용 프로그램"작업을 보자

~/.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

, doc2.rake는 예를 들어, .rake 파일에 앱의 lib/tasks 디렉토리에 넣고.

원본을 유지하려면 작업 이름을 업데이트하십시오 (예 : "app2").

"doc/README_FOR_APP" 문자열을 더 넓은 패턴으로 업데이트하거나 처리 할 새 파일을 추가하십시오.

doc/Cheatsheet_FOR_APP을 작성하면 새로운 rake doc:app2 태스크가이를 선택합니다.

출처

2012-05-13 23:39:15

RDoc에 페이지를 추가하는 방법은 무엇입니까?

답변

관련 문제