레일 응용 프로그램 용 Rdoc 생성

내 레일 (2.3.8) 프로젝트에 대한 문서를 생성하고 싶습니다. 내가레일 응용 프로그램 용 Rdoc 생성

rake doc:rails 
rake doc:rerails

그것은 표준 루비 클래스와 공급 업체 디렉토리에있는 모든 루비 파일을 포함하여 모든 클래스에 대한 문서를 생성을 시도했을 때 (플러그인 등)

난 단지 루비 클래스에 대한 rdoc 문서를 만들 수있는 방법, 다음 디렉토리에있는 파일은

응용 프로그램 폴더 (모든 모델, 컨트롤러 및 뷰)
config 폴더
lib 폴더

출처

2011-09-02 sameera207

이 내용을 내 Rakefile에 추가했습니다.

RDoc::Task.new :rdoc do |rdoc| 
    rdoc.main = "README.rdoc" 

    rdoc.rdoc_files.include("README.rdoc", "doc/*.rdoc", "app/**/*.rb", "lib/*.rb", "config/**/*.rb") 
    #change above to fit needs 

    rdoc.title = "App Documentation" 
    rdoc.options << "--all" 
end

다음을 실행하십시오.

rake rdoc

http://rdoc.rubyforge.org/RDoc/Task.html

틀림없이 내가 더 레일 3 응용 프로그램에

체크 아웃에 대한 RDoc :: 작업 문서를,하지만 난이 동일하게 작동합니다 생각합니다.

출처

2011-11-28 13:50:49 Sujimichi

rake doc:app을 사용하면 앱에 대한 설명서를 생성 할 수 있습니다.

Rails guides의 2.4 절에서 인용 :

기타 문서 : 네임 스페이스가 응용 프로그램, API 문서, 가이드에 대한 문서를 생성하는 도구가 있습니다. 문서는 또한 을 제거 할 수 있습니다. 이는 임베디드 플랫폼 용 Rails 애플리케이션을 작성하는 것처럼 코드베이스를 줄이는 데 주로 유용합니다.

rake doc : app은 doc/app에서 애플리케이션에 대한 설명서를 생성합니다. rake doc : guides는 doc/guides에서 레일스 가이드를 생성합니다. rake doc : rails 은 doc/api에서 Rails에 대한 API 문서를 생성합니다.

출처

2015-09-24 11:46:29 lorefnon

레일 응용 프로그램 용 Rdoc 생성

답변

관련 문제