代码之家 › 专栏 › 技术社区 › tjwrona1992

自动更新Doxygen文档并使其随时可供使用CMake的用户使用

documentation-generation doxygen documentation cmake

0

tjwrona1992 · 技术社区 · 6 年前

因为老实说,大多数人根本不喜欢阅读文档,更不用说搜索文档了。

有没有一个标准的位置来安装文档,一旦它是建立的,它让用户非常清楚,文档是一个库可用的?
如何确保每次构建库时,文档都是自动更新并安装在此标准位置?
有没有标准的方法来保存文档的旧版本以备参考,以防有人使用库的早期版本?

0 回复 | 直到 6 年前

1

Mizux The Dreams Wind 6 年前

Filesystem Hierarchy Standard

4.11.3. 特定选项
如果安装了相应的子系统,则以下目录或指向目录的符号链接必须位于/usr/share中:

...
博士其他文件(可选)

/usr/共享/文档

另外,在build dir中首先有doxygen,看起来还可以。

3) 通常发行版有一个包管理器,你可以创建一个文档包,所以想要“过去”文档的用户只需要得到与二进制包具有相同版本的包文档。。。

注意:在Archlinux上,doc随库提供,在Debian上,就像包doc一样,与homebrew IIRC相同

注意:您还可以配置doxygen,这样生成的错误消息就可以被ide(例如QtCreator)像常规gcc错误一样解析,这样您就可以在每次生成时的错误日志中看到它们。

2

1

albert 6 年前

你似乎有两个截然不同的问题:

A、构建软件的开发人员甚至不知道他们正在使用的构建的doxygen部分

B、普通用户也不知道有可用的文档(来自doxygen或其他)

B、这不是一个真正的技术问题,所以我将把重点放在开发人员上。首先,您应该使doxygen部分的构建“选择退出”,我的意思是默认启用。只需为此使用一个常规的(并且是假的)cmake依赖项;换句话说,欺骗cmake并假装构建库需要构建doxygen。在doxygen规则/命令中,将cmake注释特性与以下内容一起使用:COMMENT“doxygen building documentation In${DOXYOUT}”。由于通常需要一段时间,开发人员会注意到。在构建的最后使用cmake消息“Reminder,you just builded documentation in${DOXYOUT}”

现在回到更具体的问题:

无标准位置,但请参见上文。

还可以看看 https://readthedocs.org/