eventbus icon indicating copy to clipboard operation
eventbus copied to clipboard

[FEATURE] Add Proper Documentation

Open DeveloperPaul123 opened this issue 3 years ago • 0 comments

We need to add proper documentation to the code. This can also include integrating Doxygen and auto publishing documentation to Github pages.

Sample workflow:

name: Documentation

on:
  push:
    tags:
      - "*"

env:
  CPM_SOURCE_CACHE: ${{ github.workspace }}/cpm_modules

jobs:
  build:
    name: Build and publish documentation
    runs-on: macos-latest
    steps:
      - uses: actions/checkout@v2

      - uses: actions/cache@v2
        with:
          path: "**/cpm_modules"
          key: ${{ github.workflow }}-cpm-modules-${{ hashFiles('**/CMakeLists.txt', '**/*.cmake') }}

      - name: Install dependencies
        run: |
          brew install doxygen
          pip3 install jinja2 Pygments
      - name: Build
        run: |
          cmake -Sdocumentation -Bbuild
          cmake --build build --target GenerateDocs
      - name: Publish
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./build/doxygen/html

DeveloperPaul123 avatar Nov 10 '21 13:11 DeveloperPaul123