Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add doxygen docs to GitHub Pages site #274

Merged
merged 14 commits into from
Apr 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/jekyll-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ jobs:

- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

- name: Install Doxygen
run: sudo apt install -y doxygen

- name: Generate Doxygen docs
run: doxygen ./OdbDesignLib/doxygen.conf

- name: Setup Pages
uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4.0.0
Expand All @@ -42,6 +48,9 @@ jobs:
with:
source: ./docs
destination: ./_site

# - name: Copy Doxygen docs
# run: cp -r ./OdbDesignLib/doxygen/html ./_site/api

- name: Upload artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
Expand Down
22 changes: 1 addition & 21 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,6 @@

/.vs
/out
OdbDesignLib/OdbDesignLib_wrap.cxx
PyOdbDesignLib/dist/
PyOdbDesignLib/_PyOdbDesignLib.dll
PyOdbDesignLib/PyOdbDesignLib.py
PyOdbDesignLib/_PyOdbDesignLib.pyd
PyOdbDesignLib/__pycache__/
PyOdbDesignServer/Lib/
PyOdbDesignServer/PyOdbDesignServer/__pycache__/
PyOdbDesignServer/pyvenv.cfg
PyOdbDesignServer/db.sqlite3
PyOdbDesignServer/Scripts/
PyOdbDesignServer/api/__pycache__/
PyOdbDesignServer/PyOdbDesignLib/
/cmake-build-debug
build/
/vcpkg_installed
Expand All @@ -25,7 +12,6 @@ build/
/.idea/workspace.xml
ssl/
artifacts/
doxygen/docs/
/TEST_DATA
OdbDesignTests/Testing/
Testing/
Expand All @@ -36,15 +22,9 @@ testlog.xml
/OdbDesignTests/CMakeLists_Local.txt
/OdbDesignTests/DesignNameTests_Local.cpp
/output
OdbDesignServer/api/__pycache__/
OdbDesignServer/api/migrations/__pycache__/
OdbDesignServer/OdbDesignServer/__pycache__/
OdbDesignServer/PyOdbDesignLib/__pycache__/
OdbDesignServer/PyOdbDesignLib/PyOdbDesignLib.py
OdbDesignServer/db.sqlite3
OdbDesignServer/PyOdbDesignLib/_PyOdbDesignLib.pyd
/TEST_DATA.zip
deploy/kubeconfig
Dockerfile.commentedOut
scripts/create-release-invoker.js
/compose-designs
docs/api/
28 changes: 1 addition & 27 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ if (NOT DEFINED ENV{CI})
set(CMAKE_CXX_COMPILER_LAUNCHER "${CCACHE_EXE}")
endif()

# required for SWIG python wrapper
#set(CMAKE_POSITION_INDEPENDENT_CODE ON)

#
# GoogleTest support
#
Expand Down Expand Up @@ -58,6 +55,7 @@ if (MSVC)
add_compile_options(/wd4251)
# ignore C4100: 'identifier': unreferenced formal parameter
add_compile_options(/wd4100)
#add_compile_options(/sdl)
else()
# additional warnings
add_compile_options(-Wall -Wextra -Wpedantic)
Expand All @@ -73,27 +71,3 @@ add_subdirectory("OdbDesignLib")
add_subdirectory("OdbDesignServer")
add_subdirectory("Utils")
add_subdirectory("OdbDesignTests")

#
# Doxygen
#
find_package(Doxygen)

if (DOXYGEN_FOUND)
# set input and output files
set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/doxygen/Doxyfile.in)
set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.out)

# request to configure the file
configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
message("Configuring Doxygen")

# Note: do not put "ALL" - this builds docs together with application EVERY TIME!
add_custom_target( docs
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen"
VERBATIM )
else (DOXYGEN_FOUND)
message("Doxygen needs to be installed to generate the doxygen documentation")
endif (DOXYGEN_FOUND)
96 changes: 7 additions & 89 deletions CMakePresets.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,33 +36,15 @@
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Debug"
}
},
{
"name": "python-x64-debug",
"displayName": "Python x64 Debug",
"inherits": "x64-debug",
"cacheVariables": {
"PYTHON_MODULE_BUILD": true,
"CMAKE_POSITION_INDENPENDENT_CODE": true
}
},
},
{
"name": "x64-release",
"displayName": "x64 Release",
"inherits": "x64-debug",
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Release"
}
},
{
"name": "python-x64-release",
"displayName": "Python x64 Release",
"inherits": "x64-release",
"cacheVariables": {
"PYTHON_MODULE_BUILD": true,
"CMAKE_POSITION_INDENPENDENT_CODE": true
}
},
},
{
"name": "x86-debug",
"displayName": "x86 Debug",
Expand Down Expand Up @@ -123,23 +105,7 @@
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Release"
}
},
{
"name": "python-linux-release",
"displayName": "Python Linux Release",
"inherits": "linux-release",
"cacheVariables": {
"PYTHON_MODULE_BUILD": true
}
},
{
"name": "python-linux-debug",
"displayName": "Python Linux Debug",
"inherits": "linux-debug",
"cacheVariables": {
"PYTHON_MODULE_BUILD": true
}
},
},
{
"name": "linux-mingw-w64-debug",
"displayName": "Linux MinGW-w64 Debug",
Expand Down Expand Up @@ -235,19 +201,7 @@
"displayName": "x86 Release",
"inherits": "windows-base",
"configurePreset": "x86-release"
},
{
"name": "python-x64-debug",
"displayName": "Python x64 Debug",
"inherits": "windows-base",
"configurePreset": "python-x64-debug"
},
{
"name": "python-x64-release",
"displayName": "Python x64 Release",
"inherits": "windows-base",
"configurePreset": "python-x64-release"
},
},
{
"name": "linux-base",
"hidden": true,
Expand All @@ -268,19 +222,7 @@
"displayName": "Linux Release",
"configurePreset": "linux-release",
"inherits": "linux-base"
},
{
"name": "python-linux-debug",
"displayName": "Python Linux Debug",
"configurePreset": "python-linux-debug",
"inherits": "linux-base"
},
{
"name": "python-linux-release",
"displayName": "Python Linux Release",
"configurePreset": "python-linux-release",
"inherits": "linux-base"
},
},
{
"name": "linux-mingw-w64-base",
"hidden": true,
Expand Down Expand Up @@ -357,19 +299,7 @@
"displayName": "Test x86-Release",
"inherits": "windows-base",
"configurePreset": "x86-release"
},
{
"name": "python-x64-debug",
"displayName": "Test Python x64 Debug",
"inherits": "windows-base",
"configurePreset": "python-x64-debug"
},
{
"name": "python-x64-release",
"displayName": "Test Python x64 Release",
"inherits": "windows-base",
"configurePreset": "python-x64-release"
},
},
{
"name": "linux-base",
"hidden": true,
Expand All @@ -390,19 +320,7 @@
"displayName": "Test Linux Release",
"configurePreset": "linux-release",
"inherits": "linux-base"
},
{
"name": "python-linux-debug",
"displayName": "Test Python Linux Debug",
"configurePreset": "python-linux-debug",
"inherits": "linux-base"
},
{
"name": "python-linux-release",
"displayName": "Test Python Linux Release",
"configurePreset": "python-linux-release",
"inherits": "linux-base"
},
},
{
"name": "linux-mingw-w64-base",
"hidden": true,
Expand Down
82 changes: 0 additions & 82 deletions Dockerfile (exe)

This file was deleted.

Loading
Loading