【问题标题】:Autobuild Sphinx+Doxygen documentation on GitHub PagesGitHub 页面上的自动构建 Sphinx+Doxygen 文档
【发布时间】:2021-10-23 03:37:32
【问题描述】:

我的文档位于/docsmaster 分支。 Sphinx 设置为将构建的文档存储在/docs/build 文件夹中(来源在/docs/source)。如何设置 GitHub 页面以在每次推送时自动构建我的文档?

P.S:在/docs/buildmaster/gh-pages 上存储构建页面都可以。

【问题讨论】:

  • 你在互联网上搜索例如:github actions sphinx doxygen
  • 互联网?它是 JavaScrips 框架还是什么?.. 当然,我搜索了一些文章,但没有找到对我有帮助的文章。

标签: github github-pages python-sphinx doxygen


【解决方案1】:

有 4 个 GitHub Actions 帮助了我。

  1. Doxygen Action 提取 doxygen 文档
  2. Sphinx Action 构建 sphinx 文档(它甚至可以理解 python 的 requirements.txt
  3. Upload Artifact 存储构建的文档
  4. GitHub Push 将更改推送到 gh-pages

实际上,我发现使用 GitHub Actions 非常方便。有很多预制的工具,非常好且易于理解。

P.S:我的工作流代码可以在here 找到。随意使用。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2011-07-16
    • 1970-01-01
    • 2020-12-08
    • 2019-11-29
    • 2014-09-06
    • 1970-01-01
    • 2011-06-09
    • 2016-05-26
    相关资源
    最近更新 更多