在另一个站点中嵌入 doxygen 文档?

Posted

技术标签:

【中文标题】在另一个站点中嵌入 doxygen 文档?【英文标题】:Embed doxygen documentation in another site? 【发布时间】:2014-02-06 02:08:47 【问题描述】:

我正在尝试embed doxygen documentation 进入另一个网站。目前我将它嵌入了 iframe,但它的副作用是,例如,如果我在新选项卡上打开文档中的任何链接,它将转到框架外单独链接的 doxygen 页面。

主站点也恰好是用sphinx 生成的,但是breathe 扩展还没有准备好自动组织这样复杂的文档,而无需手动编写许多.rst 文件。

另外,在reference page 上可以找到 doxylink 参考链接,例如 this link to a file。

似乎shark machine learning 库能够在某种程度上通过类列表实现这一壮举,但很难确定他们使用的确切技术。另外,他们的许可证是 GPL,与我图书馆的 BSD 许可证不兼容。

如何确保始终嵌入文档?

下面是正确嵌入页面的显示方式:

但有些链接会指向这样的页面:

【问题讨论】:

【参考方案1】:

您实际上是在 iframe 中打开一个链接,并希望在同一个 iframe 中打开该链接。这可以通过以下方式完成:

<iframe src="http://cnn.com/" name="myFrame"></iframe>
<p>
    <a href="http://cnn.com/" target="myFrame"></a>
</p>

这会将所有链接加载到同一个 iframe 中。

这是我的 JSFiddle:http://jsfiddle.net/yb82en46/

来源

How to open a iframe link within the same iframe? - ***

您应该指定 iframe 的目标名称。

<iframe src="demo_iframe.htm" name="iframe_a"></iframe>
<p><a href="http://www.w3schools.com" target="iframe_a">www.google.com</a></p>

【讨论】:

以上是关于在另一个站点中嵌入 doxygen 文档?的主要内容,如果未能解决你的问题,请参考以下文章

用doxygen风格注释代码生成文档

doxygen上手

doxygen上手

一款常用文档生成工具:Doxygen

doxygen的使用配置并生成文档

代码注释规范之Doxygen