2013-04-02 6 views
0

레일즈 3.2.13 앱에 몇 가지 문서를 추가했습니다.레일 애플리케이션 문서를 생성하기위한 RDoc 템플릿 변경

# lib/tasks/documentation.rake 
Rake::Task["doc:app"].clear 
Rake::Task["doc/app"].clear 
Rake::Task["doc/app/index.html"].clear 

namespace :doc do 
    RDoc::Task.new('app') do |rdoc| 
     rdoc.rdoc_dir = 'doc/app' 
     rdoc.generator = 'hanna' 
     rdoc.title  = 'Stoffi Web App Documentation' 
     rdoc.main  = 'doc/Overview' 
     rdoc.options << '--charset' << 'utf-8' 
     rdoc.rdoc_files.include('app/**/*.rb') 
     rdoc.rdoc_files.include('doc/*') 
    end 
end 

을 ... 그리고 rake doc:app을 실행 : 나는 레이크 작업을 사용하여 잘 문서 (실행 RDoc 3.12.2)를 생성 할 수 있습니다. 하지만 저는 Hanna 템플릿의 기본 모양이 마음에 들지 않습니다. Hanna에서 사용되는 기본 CSS 파일을 무시하는 CSS 파일을 제공하여 CSS를 편집 할 수 있습니까?

감사합니다.

⮀ RDPATH=$(dirname $(gem which rdoc)) 
# ⇒ /home/am/.rvm/rubies/ruby-head/lib/ruby/2.1.0 

지금 (프로젝트 디렉토리로 변경 /tmp 또는 같은) 원하는 위치로 거기에서 기본 템플릿을 복사 : 모든

+0

''Gemfile'에'hanna' 보석을 추가 했습니까? 'bundle '을 실행합니까? 또한 https://github.com/rdoc/hanna-nouveau#rake-task' rdoc.generator = 'hanna'' 부분을 확인하십시오. – Kashyap

+0

갑자기 rdoc.generator를 사용하여 작업했습니다. 어쩌면 나는 보석이나 무언가를 제대로 설치하지 않았을 것입니다. 수정과 관련하여 질문을 변경하겠습니다. –

답변

2

먼저 템플릿이 어디에 있는지 찾을

⮀ cp -r $RDPATH/rdoc/generator/template/darkfish /tmp/myniftytemplate 

그리고 마지막으로, rdoc을 가르치 자 :

class RDoc::Options 
    def template_dir_for template 
    "/tmp/#{template}" 
    end 
end 

RDoc::Task.new('app') do |rdoc| 
    rdoc.template = 'myniftytemplate' 
    … 
end 

그게 전부 야. 희망이 도움이됩니다.

+0

감사합니다. Darkfish를 수정하고 싶다면 매우 도움이되었습니다. 하지만 Hanna 템플릿을 수정하려고하는데 어떻게해야하는지 알 수 없습니다. hanna-nouveau gem 내의 template_files 파일을 mytemplate 폴더에 복사하고, 배경을 수정하고, RDoc에 경로를 알려준 다음 rdoc.template = "mytemplate"을 설정합니다. 그러나 그것은 효과가 없습니다. Hanna에서 여전히 기본 템플릿을 얻습니다. RDoc에서 오류가 없습니다. –

+1

Oooups, 미안 템플릿 엔진이'hanna'라고 오해했습니다. [sources] (https://github.com/mislav/hanna/blob/master/lib/hanna/hanna.rb) (15 행, 35 행)에 따르면'hanna'의 템플릿 파일은 현재 매우 어렵습니다 - 코딩 됨. 나는 추한 것처럼 들리지만, 템플리트를 적절한 위치에 패치하거나 "hanna.rb"를 패치하여 사용자 정의 위치에서'sass'를로드하는 것을 제외하고는 템플리트를 대체 할 수있는 방법이 없습니다. – mudasobwa