在 C++ 中从 Doxygen 风格的 XML 注释生成 GitHub wiki 页面

Question

我对我正在从事的 C++ 项目有 Doxygen 风格的 XML 注释，并且希望将其从这些注释中创建一个 GitHub wiki 页面。最好的方法是什么？我无法使用 GitHub 页面。我尝试过 pandoc，但它生成的页面看起来不太好，但我不确定这是因为我使用错误还是其他原因。

任何帮助表示赞赏。谢谢！

Answer 1

使用GitHub Pages，您可以将选定分支的/docs/根或根/用于提供文件，并且可以通过常规链接.html访问它：（无论您的存储库隐私如何，它都将是公开的），您还可以执行 GitHub Action因此使用以下模板https://github.com/actions/starter-workflows/blob/main/pages/static.yml。github.iohttps://<user_or_organization>.github.io/<repository>/

最后一部分是进行推送操作（在 PR 上推送到主分支，或者如果某个目录发生更改则直接推送到主分支），并且该工作流程可以如此简单：

jobs:
  build:
    name: ...
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      # ...
      - name: Commit Doxygen updates
        run: |
          git config user.name github-actions
          git config user.email github-actions@github.com
          git diff-index --quiet HEAD || git commit -am "Automated Doxygen updates"
          git push

无需浏览 XML 文件，关于 GitHub wiki 评论，如果您选择 Pages，那么 XML 文件就是解决方案，因为您可以将它们转换为 Markdown 文件