Generate C/Fortran API docs with Doxygen

.github/workflows/Documenter.yml

@@ -45,3 +45,25 @@ jobs:
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
           GKSwstype: 100 # To make GitHub Action work, disable showing a plot window with the GR backend of the Plots package
         run: julia --project=docs --color=yes docs/make.jl
+
+  build-doxygen:
+    runs-on: ubuntu-latest
+    needs: build-docs
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Install doxygen
+        run: |
+          sudo apt-get install -y doxygen
+      - name: Build doxygen docs
+        run: |
+          cd docs/doxygen
+          doxygen
+      - name: Deploy doxygen docs (only on main)
+        # if: ${{ github.ref == 'refs/heads/main' }} # TODO remove comment before merge!
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./docs/doxygen/build/html
+          destination_dir: c-fortran-api

.gitignore

@@ -14,8 +14,5 @@ cmake_install.cmake
 libtrixi.mod
 libtrixi.so*
 
-# Documenter
-docs/build
-
 # VS Code
 .vscode

LibTrixi.jl/src/api_c.jl

@@ -9,9 +9,9 @@ The libelixir has a similar purpose as a regular "elixir" in Trixi.jl, as it com
 defines a simulation setup in Julia code. A key difference (and thus the name libelixir) is
 that instead of running a simulation directly, it should define an argument-less function
 named `init_simstate()` that returns a [`SimulationState`](@ref) with the complete
-simulation setup. `trixi_initialize_simulation` will store the `SimulationState` object internally and
-allow one to use it in subsequent calls to libtrixi via the handle returned from this
-function.
+simulation setup. `trixi_initialize_simulation` will store the `SimulationState` object
+internally and allow one to use it in subsequent calls to libtrixi via the handle returned
+from this function.
 
 For convenience, when using LibTrixi.jl directly from Julia, one can also pass a regular
 `String` in the `libelixir` argument.