我几乎没有使用HTML的经验,但我使用Doxygen来创建代码文档。我将所有Doxygen生成的HTML文件放在我的C项目的子目录中。
本文档适用于我构建的库,我希望用户能够查看HTML文档,而无需搜索index.html
的Doxygen子目录。我试图创建一个index.html
的Windows快捷方式,但这只适用于我的工作计算机。每当我尝试使用另一台计算机时,Windows都会请求我的工作计算机的用户名和密码。然后我尝试将index.html
文件复制到我的库的顶层;但是,这样做似乎很多链接都被破坏了,文件没有正常打开。
请注意,我不打算在服务器上托管此文档,文档将与源代码一起分发,因为此库(目前)用于内部教育大学使用,我不确定是否允许使它成为开源的。
换句话说,这是我正在寻找的文件结构类型:
Project Folder
-Doxygen Documentation Folder
-index.html
-Source Code Folder
-Shortcut to index.html
答案 0 :(得分:2)
有一个 here 主题可以提供帮助。
基本上,建议是让顶级index.html
将阅读器链接或重定向到doxygen文件夹中的阅读器。我注意到你是HTML的新手,但它很简单。
有一个最小index.html
的例子,你可以使用该线程的底部,我将在这里复制,以防线程消失。它由Clemens Feige提供。
<head>
<meta http-equiv="refresh" content="1; URL=doxygen/index.html">
</head>
<body>
<p>You will be redirected automatically, otherwise please <a
href="doxygen/index.html">click here</a>.</p>
</body>
您需要根据您的设置调整路径。
答案 1 :(得分:0)
我最终使用this software但我认为我更喜欢Cheeseminer的解决方案