在Doxygen输出中更改index.html文件的位置

15
我正在使用Doxygen创建HTML输出。 我想自定义输出,使得index.html文件更加引人注目,因为现在它深埋在html输出文件夹的一大堆文件中间。 例如,如果将其移到上一级目录以使其不再是“碎片”html文件之一,那么对于其他需要查找该文件的用户来说,它就会更加易于访问。但是,我不能只添加一行脚本将其复制到该位置,因为它所有的链接都会损坏。 如果我可以配置Doxygen使索引文件到达不同的位置,或者您能想到其他解决方案,请回复我,谢谢。

为什么不创建一个符号链接或快捷方式到 index.html,然后将其放在任何你喜欢的地方呢?此外,如果你在图形文件管理器中输入一个字母,通常会跳转到以该字母开头的第一个文件。对我来说,按下 i 直接跳转到 index.html - Chris
@Chris 谢谢你的建议。我会尝试这样做。对于知道该查找什么的人来说,很容易找到它,但是使用目录的人可能不知道要在那里查找。我只是想让它尽可能简单明了。 - user1488804
当然,将指向./html/index/html的符号链接/快捷方式放在项目根目录中可能是最好的选择。您可以随意命名此符号链接以使用户明确其含义。 - Chris
@Chris,它运行得很好。随意添加您的评论作为答案,我会为您打勾。谢谢。 - user1488804
2个回答

18

我会保留文档在原地,而是使用HTML语言的meta refresh选项。将一个名为“Documentation.html”的文件放置在您想要的任何文件夹中,并拥有以下内容:

<meta http-equiv="REFRESH" content="0;URL=RELATIVE/PATH/TO/index.html">

2

如我在对OP的评论中提到的那样,最简单的解决方案可能是创建一个符号链接或快捷方式到doxygen生成的index.html文件,而不是试图让doxygen改变其输出文件的布局。这个符号链接/快捷方式可以放置在您项目的根目录(或其他地方),指向./html/index/html,并命名为任何您喜欢的名称,以使用户明白它的作用。


2
还有一件事情,也许你能帮我解决:在这个文件夹到达最终用户之前,它会被压缩,然后在 Windows 机器上解压缩。问题是符号链接在 Windows 上不起作用,而只会变成包含链接的文本文件。我无法想出解决这个跨平台问题的方法(即使使用我的有限搜索能力)。你有什么想法吗? - user1488804
这可能最好作为一个单独的问题来询问。我不知道如何以可移植的方式创建符号链接,如果有简单的方法做到这一点,我会感到惊讶。您可以为Linux和Windows分别创建符号链接(后者使用mklink)。但是我不确定这些链接是否有效,因为您需要指向相对路径。 - Chris
我能想到的唯一方法,现在我会尝试一下,就是制作一个包含少量指向子目录文件的 JavaScript 的 HTML 文件(称为 index 或其他名称)。但是,是的,我会将其作为单独的问题来询问,因为我可能需要一些了解 JavaScript 的人(而不是我),来帮助我。 - user1488804

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接