From 15bc315c0a76cc7b79f60c88411a4e8617c8a2ba Mon Sep 17 00:00:00 2001 From: Andreas Kuhner Date: Fri, 6 Sep 2024 10:32:36 +0200 Subject: [PATCH] docs: Using github actions to build docu --- .github/workflows/doxygen.yml | 36 +++++++++++++++++++++++++++++++++++ doc/Doxyfile.in | 2 +- 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/doxygen.yml diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml new file mode 100644 index 00000000..28b39ddc --- /dev/null +++ b/.github/workflows/doxygen.yml @@ -0,0 +1,36 @@ +name: Generate Doxygen documentation + +on: + push: + branches: + - PRCUN-2883-update-doxygen + pull_request: + branches: + - main + +jobs: + doxygen: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Install Doxygen + run: sudo apt-get install doxygen graphviz -y + + - name: Generate Doxygen configuration + run: cp doc/Doxyfile.in Doxyfile + + - name: Create documentation directory + run: mkdir -p docs + + - name: Generate Doxygen documentation + run: doxygen Doxyfile + + - name: Deploy to GitHub Pages + if: ${{ github.ref == 'refs/heads/main' }} + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/html diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 848559b5..c6521524 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -58,7 +58,7 @@ PROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/Logo_FRANKA_ROBOTICS_dark.pn # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = docs # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and