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，因此当我单击链接时该链接断开。

我试图将这些文件移动到doc文件夹中，但是YARD会生成类似doc/doc/static/logo/mytool.png的引用。注意参考中有两个doc。

我是围场和红宝石。解决此问题的最佳实践是什么？ YARD可以将此文件复制到doc文件夹吗？

Answer 1

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

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

YARD生成对文件的错误引用

1 个答案: