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.png和doc/LICENSE.txt，所以点击link就坏了

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

我是 YARD 和 ruby 的新手。处理此问题的最佳做法是什么？ YARD 可以将此文件复制到 doc 文件夹吗？

Answer 1

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

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

YARD 生成错误的文件引用

YARD generates wrong references to files

ruby

yard

yardoc