【问题标题】:Travis-CI does not publish doxygen file-level documentationTravis-CI 不发布 doxygen 文件级文档
【发布时间】:2019-05-23 07:55:45
【问题描述】:

我有一个 project,我正在 CI 工作中构建 doxygen 文档和 publishing using github-pages

但是,我遇到了一个问题,文件文档(即使用 doxygen's @file command 生成)没有上传 - 链接存在并且文件存在于 gh-pages 分支中,但单击任何链接会导致404 错误。例如this 应该指向this 文件但链接已失效。

据我所知,这是因为 Jekyll 忽略了名称以下划线开头的任何文件,这是 doxygen 使用的输出模式(据我所知)无法改变它。看起来要解决这个问题,你需要告诉 Jekyll 包含这些文件,但到目前为止这对我不起作用。

我试过了

我在 master 分支上创建的任何这些文件似乎都在 gh-pages 分支中被忽略了,而我在 gh-pages 分支上创建的任何文件都(可以预见地)被 travis 覆盖。

我怎样才能将这些文件发布到网页上?

【问题讨论】:

  • 一个真实的例子和使用的 doxygen 版本一样有用。此外,一切都正确构建了吗?或者它只是一个不工作的上传部分还是......
  • 我不确定您所说的真实示例是什么意思 - 您想要的不仅仅是指向 github 项目和文档页面的链接吗?一切都正确构建 - 例如 linked html file on the gh-pages branchpublished documentation for one of the classes
  • 看起来它是用非常旧的 doxygen 版本(1.8.6,从 2013 年 12 月开始)构建的,而当前版本是 1.8.15。您可以查看配置设置CASE_SENSE_NAMES,也许这可以帮助您克服_ -names 的问题。
  • 嗨 - 对不起,我忘了回答你关于 doxygen 版本的问题 - 我只是使用 CI 默认抓取的任何一个。 CASE_SENSE_NAMES 有效!如果您想在答案中重复它,以便我可以接受,那就太好了。
  • 我不建议使用默认 (1.8.6) 版本,而是使用更新版本的 doxygen

标签: github travis-ci doxygen github-pages


【解决方案1】:

默认情况下,Doxygen 决定如何根据所使用的操作系统创建输出文件名。这导致 a.o.在不区分大小写的系统上,总是有唯一的名称(例如,用下划线替换大写字符,后跟相应的小写字符(下划线替换为双下划线)。 为了引导这一点,可以使用配置参数CASE_SENSE_NAMES

来自文档 (1.8.15):

CASE_SENSE_NAMES 如果 CASE_SENSE_NAMES 标签设置为 NO 则 doxygen 只会生成小写字母的文件名。如果设置为是, 也允许使用大写字母。这很有用,如果你有 名称仅在大小写以及您的文件时不同的类或文件 系统支持区分大小写的文件名。

建议 Windows 和 Mac 用户将此选项设置为 NO。

默认值为:系统依赖。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2019-05-21
    • 2019-12-28
    • 2022-01-08
    • 2017-08-09
    • 1970-01-01
    • 1970-01-01
    • 2018-07-15
    • 1970-01-01
    相关资源
    最近更新 更多