ruby - YARD 生成对文件的错误引用

Question

我使用 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 生成的文档包含这个自述文件，但它有一个小问题。文件的路径static/logo/mytool.png和LICENSE.txt错误。生成的index.html指向doc/static/logo/mytool.pngand doc/LICENSE.txt，所以当我点击它时链接被破坏了。

我试图将这些文件移动到doc文件夹，但 YARD 会生成这样的引用doc/doc/static/logo/mytool.png。注意双重doc参考。

我是 YARD 和红宝石的新手。处理这个问题的最佳实践是什么？YARD 可以将此文件复制到 doc 文件夹吗？

标签： rubyyardyardoc

Answer 1

--asset通过yard help doc或此处查看选项。鉴于上面的示例，这应该可以解决问题：

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