我的markdown文件中的大多数链接都由Doxygen(Fedora 28上的版本1.8.14)正确呈现,例如:
[utils](src/thing/utils/README.md)
即使Doxygen的html版本的自述文件的路径是秘密的,Doxygen也会解决该问题,并且该链接有效。但是当我链接到头文件时,Doxygen会生成一个奇怪的相对路径,该路径无处可通:
[Widget.hpp](src/thing/utils/Widget.hpp)
在github上,此链接有效,但Doxygen生成的html中的路径为:
../../src/thing/utils/Widget.hpp
我想要Doxygen将其链接解析为它为Widget.hpp
生成的html文档页面。有没有办法做到这一点,并保持与github的兼容性?如果需要Doxygen预处理器甚至我自己的预处理脚本(在Doxygen之前运行并将README.md
的临时副本中的链接更改为Doxygen可以理解的链接),对我来说很好。
答案 0 :(得分:1)
有点困难的情况。
文件README.md由doxygen转换,并使用结果。还翻译了widget.hpp,但是由于不清楚要链接的内容,即源代码或文档,因此在结果树中提供了对原始文件的引用,并且该文件被视为可以在HTML中找到的文件那个位置的树。
所以最好的办法是在HTML目录中创建路径,然后将文件复制到该位置。
最好在doxygen问题附加程序(https://github.com/doxygen/doxygen/issues/new)中创建问题,并附带一个小而独立的示例(tar +或zip中的source + config文件;请不要引用外部资源),可以重现该问题。