Как документировать больше файлов, кроме файла `readme`?

Question

Я использую Ruby на Rails 3.1.0 и Яр 0,7,4 жемчужина для целей документации. Я хотел бы добавить больше файлов, кроме README Файл в верхней части сгенерированной документации, как сделано здесь (видеть README, What's New?, Getting Started Guide, Architecture Overview, ... вкладки В верхней части связанной страницы в разделе «Список файлов»).

То есть по умолчанию драгоценный камень, похоже, генерирует только документацию, связанную с README Файл, присутствующий в корневом каталоге моего приложения ROR. Я хотел бы документировать другие файлы и для каждого из них добавить вкладку в верхней части документации (как сделано на ранее связанной странице).

Является ли это возможным? Если так, как я могу это сделать? Более того, должен ли я создать новый каталог (в корне моего приложения ROR), содержащий мои «пользовательские» файлы, используемые в целях документации?

Answer 1

При чтении документации для Двор: инструмент командной строки, вы найдете следующее:

Вы также можете добавить файл .yardopts в свой каталог проектов, в котором перечислены переключатели, разделенные WhiteSpace (новые линии или пространство), чтобы пройти в Yardoc, когда он запускается.

Выше, есть намек на то, что, используя - README LICENSE FAQ, эти файлы будут добавлены в документацию.

А .yardopts файл для двора сам содержит:

-
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

Я думаю, что это объясняет, почему все эти файлы являются частью документации. Однако я не знаю, доступны ли они как вкладки автоматически.