YARD генерирует неверные ссылки на файлы - PullRequest
0 голосов
/ 30 января 2019

Я использую YARD, чтобы сгенерировать документ для проекта ruby.Этот проект включает файл README.md и выглядит следующим образом:

# MyTool

<p align="center">
    <img src="static/logo/mytool.png">
</p>

Welcome to your new gem!

...

## Copyright

Copyright (C) 2019 Company. See [License](LICENSE.txt) for further details.

Документ, созданный YARD, включает этот файл readme, но у него есть небольшая проблема.Пути к файлам static/logo/mytool.png и LICENSE.txt неверны.Сгенерированные index.html указывают на doc/static/logo/mytool.png и doc/LICENSE.txt, поэтому, когда я нажимаю на них, ссылка разрывается.

Я пытался переместить эти файлы в папку doc, но YARD генерирует ссылки, подобные этойdoc/doc/static/logo/mytool.png.Обратите внимание на двойной doc в ссылке.

Я новичок с ЯРДОМ и рубином.Как лучше всего справиться с этой проблемой?Может ли YARD скопировать эти файлы в папку с документами?

1 Ответ

0 голосов
/ 25 марта 2019

Проверьте параметр --asset, через yard help doc или здесь .Учитывая ваш пример выше, это должно сработать:

yard doc --asset static --asset LICENSE.txt
...