`README` 파일이 아닌 다른 파일을 문서화하는 방법은 무엇입니까?

Question

저는 Ruby on Rails 3.1.0과 YARD 0.7.4 gem을 사용하고 있습니다. 나는 "파일 목록에서 (링크 된 페이지의 상단에 README, What's New?, Getting Started Guide, Architecture Overview, ... 탭를 참조했다 here로 생성 된 문서의 상단에 README 파일 이외의 파일을 더 추가하고 싶습니다 "섹션 참조).

기본적으로 YARD 보석은 RoR 응용 프로그램의 ROOT 디렉토리에있는 README 파일과 관련된 설명서 만 생성하는 것으로 보입니다. 다른 파일을 문서화하고 각 파일에 대해 이전에 링크 된 페이지 에서처럼 문서 상단에 탭을 추가하고 싶습니다.

가능합니까? 그렇다면 어떻게 할 수 있습니까? 더 많은 경우, 문서화에 사용되는 "사용자 정의"파일을 포함하는 새 디렉토리 (RoR 응용 프로그램의 루트에 있음)를 만들어야합니까?

Answer 1

YARD: Command line tool 설명서를 읽을 때, 당신은 발견 할 것이다 다음

당신은 또한 공백 (줄 바꿈 또는 공간)에 의해 분리 된 스위치에 전달하기를 나열하는 프로젝트 디렉토리에 .yardopts 파일을 추가 할 수 있습니다 실행될 때마다 야드 콥.

위의 경우 - README LICENSE FAQ을 사용하면 이러한 파일이 설명서에 추가됩니다.

.yardopts file for YARD 자체는 포함

- 
docs/WhatsNew.md 
docs/GettingStarted.md 
docs/Overview.md 
docs/CodeObjects.md 
docs/Tags.md 
docs/Parser.md 
docs/Handlers.md 
docs/Templates.md 
docs/Glossary.md 
ChangeLog 
LICENSE 
LEGAL 

내가 모든 파일이 문서의 일부 이유가 설명 생각합니다. 그들이 자동으로 탭으로 사용할 수 있는지 모르겠다.