用C++从Doxygen风格的XML注解生成GitHub wiki页面

nuypyhwy  于 2023-02-06  发布在  Git
关注(0)|答案(1)|浏览(169)

我有一个C++项目的Doxygen风格的XML注解,我想用这些注解制作一个GitHub wiki页面。最好的方法是什么?我不能使用GitHub页面。我试过pandoc,但是它生成的页面看起来不太好,但是我不确定是因为我用错了还是其他原因。
任何帮助都很感激。谢谢!

8cdiaqws

8cdiaqws1#

使用GitHub Pages,您可以使用/docs/或所选分支的根/来提供.html文件,并且可以通过常规github.io链接访问:https://<user_or_organization>.github.io/<repository>/(无论您的回购隐私如何,它都是公开的),您也可以使用以下模板https://github.com/actions/starter-workflows/blob/main/pages/static.yml通过GitHub Action来执行此操作。
最后一部分是有一个推的动作(要么在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

关于GitHub wiki评论,没有必要通过XML文件,如果你选择它而不是页面,那么XML文件就是解决方案,因为你可以将它们转换成Markdown文件

相关问题