rakefile을 사용하여 소스에서 문서 생성

Question

ruby ​​Twitter gem 소스 코드를 다운로드했으며 gem install yard을 통해 설치 한 yard를 사용하여 설명서를 생성하려고합니다.

require 'yard' 
YARD::Rake::YardocTask.new 

내가 IRB에 require yard에 노력하고 YARD::Rake::YardocTask.new을 실행하지만 아무 일도 다음 rakefile에서, 나는 트위터 보석에 대한 문서를 생성하는 데 사용되는 가정은 다음을 발견했다.

올바른 방향으로 나아갈 수 있도록 도와 줄 수 있습니까? the YARD docs에서

Answer 1

:

두 번째 가장 확실한는 레이크 작업을 통해 문서를 생성하는 것입니다. 당신은 당신의 Rakefile에 다음을 추가하여이 작업을 수행 할 수 있습니다

YARD::Rake::YardocTask.new do |t| 
    t.files = ['lib/**/*.rb', OTHER_PATHS] # optional 
    t.options = ['--any', '--extra', '--opts'] # optional 
end 

모두 files 및 options 설정은 선택 사항입니다. files 은 lib/**/*.rb으로, options은 의 모든 옵션을 나타냅니다. 다시 한 번 셸에서 yardoc --help을 입력하면 전체 옵션 목록을 볼 수 있습니다. 또한 OPTS 환경 변수와 레이크 명령 줄에서 옵션을 을 재정의 할 수

$ rake yard OPTS='--any --extra --opts' 

는 요약 : rake yard를 실행하십시오 Rakefile에 YARD::Rake::YardocTask.new를 추가 한 후.