Skip to content

Commit

Permalink
docs: Using github actions to build docu
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreasKuhner committed Sep 6, 2024
1 parent fee3901 commit 38b0026
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 6 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
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 and build it
run: mkdir -p build && cd build && cmake -D BUILD_DOCUMENTATION=ON -D SKIP_CXX_BUILD=ON .. && make doc

- name: Deploy to GitHub Pages
if: ${{ github.ref == 'refs/heads/PRCUN-2883-update-doxygen' }}
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: build/docs/html
15 changes: 10 additions & 5 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ project(libfranka
LANGUAGES CXX
)

option(BUILD_DOCUMENTATION "Build documentation" OFF)
option(SKIP_CXX_BUILD "Skips the c++ build" OFF)
if(BUILD_DOCUMENTATION)
add_subdirectory(doc)

if(SKIP_CXX_BUILD)
return()
endif()
endif()

list(INSERT CMAKE_MODULE_PATH 0 "${CMAKE_CURRENT_SOURCE_DIR}/cmake")

set(CMAKE_CXX_STANDARD 17)
Expand Down Expand Up @@ -190,11 +200,6 @@ if(BUILD_EXAMPLES)
add_subdirectory(examples)
endif()

option(BUILD_DOCUMENTATION "Build documentation" OFF)
if(BUILD_DOCUMENTATION)
add_subdirectory(doc)
endif()

## Packaging
set(CPACK_PACKAGE_VENDOR "Franka Robotics GmbH")
set(CPACK_GENERATOR "DEB;TGZ")
Expand Down
2 changes: 1 addition & 1 deletion doc/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 38b0026

Please sign in to comment.