CODEWITHSUNDEEP
c++xmlgithubdoxygenwiki
RandomQuestions
RandomQuestions

Reputation: 113

Generating GitHub wiki pages from Doxygen style XML comments in c++

I have Doxygen style XML comments for a c++ project I am working on, and would like to take it and make a GitHub wiki page from these comments. What would be the best way to do so? I cannot use GitHub pages. I have tried pandoc, but the pages it generates do not wind up looking nice, but I am not sure if that is because I am using it wrong or some other reason..

Any help is appreciated. Thanks!

Upvotes: 7

Views: 2409

Answers (1)

Yogev Neumann
Yogev Neumann

Reputation: 2231

With GitHub Pages, you can have either the /docs/ or the root / of a selected branch to served .html files and it will be accessible through the regular github.io link: https://<user_or_organization>.github.io/<repository>/ (it will be public regardless of your repo privacy), you can also have a GitHub Action to do so using the following template https://github.com/actions/starter-workflows/blob/main/pages/static.yml.

And last part is to have an action that push (either on PR to your main branch or directly to main if there are changes to some directory), and that Workflow can be as simple as that:

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 [email protected]
          git diff-index --quiet HEAD || git commit -am "Automated Doxygen updates"
          git push

There is no need to go through XML files, regarding the GitHub wiki comment, if you choose that over Pages, then XML files are the solution as you can convert them to Markdown files

Upvotes: 0

Related Questions