diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 1f92591..5f170ab 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -1,18 +1,39 @@ -name: ci +# This is a basic workflow to help you get started with Actions + +name: Doxygen Action + +# Controls when the action will run. Triggers the workflow on push or pull request +# events but only for the master branch on: push: - branches: - - master - - main + branches: [ master ] + + + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: - deploy: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job steps: - - uses: actions/checkout@v2 - - uses: actions/setup-python@v2 - with: - python-version: 3.x - - run: pip install mkdocs-material - - run: pip install mkdocs-exclude - - run: pip install mkdocs-roamlinks-plugin - - run: mkdocs gh-deploy --force + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v2 + + - name: Doxygen Action + uses: mattnotmitt/doxygen-action@v1.1.0 + with: + # Path to Doxyfile + doxyfile-path: "./Doxyfile" # default is ./Doxyfile + # Working directory + working-directory: "." # default is . + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + # Default Doxyfile build documentation to html directory. + # Change the directory if changes in Doxyfile + publish_dir: ./html