Skip to content

Commit

Permalink
Simplify APIdoc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
kebekus committed Aug 18, 2024
1 parent 652d7d5 commit 66491a6
Show file tree
Hide file tree
Showing 3 changed files with 2,316 additions and 19 deletions.
28 changes: 9 additions & 19 deletions .github/workflows/api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,15 @@ jobs:
- name: Checkout Enroute
uses: actions/checkout@v4
with:
path: enroute
submodules: recursive
- name: Install Qt
uses: jurplel/install-qt-action@v4
with:
cache: 'true'
modules: 'qt5compat qtconnectivity qthttpserver qtimageformats qtlocation qtmultimedia qtpositioning qtserialport qtshadertools qtspeech qtwebsockets qtwebview'
version: '6.6.*'
- name: Install Additional Software
run: |
sudo apt install doxygen extra-cmake-modules graphviz libzip-dev ninja-build spirv-tools zipcmp zipmerge ziptool
- name: Compile Enroute Flight Navigation
run: |
cmake \
-B build-enroute \
-S enroute \
-DCMAKE_BUILD_TYPE=Debug
cmake --build build-enroute --target enroute_doc
mv build-enroute/src/APIdoc/html ./APIdoc
submodules: true
fetch-depth: 0
- name: Install Doxygen
uses: ssciwr/doxygen-install@v1
- name: Install doxyqml
run: pip install doxyqml
- name: Generate documentation
working-directory: docs
run: doxygen
- name: Publish Documentation
if: github.event_name == 'push'
uses: JamesIves/github-pages-deploy-action@v4
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ build-android-debug/
build-linux/
build-macos/

# Doxygen generated documentation
doc/APIdoc


# secrets
generatedSources/pc-api-8548806115718303828-770-6966308588f6.json
CMakeLists_ios.txt
Expand Down
Loading

0 comments on commit 66491a6

Please sign in to comment.