Skip to content
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
43 changes: 43 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Doxygen

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

env:
# Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
BUILD_TYPE: Release

jobs:

doc-html:

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v2

- name: Install Doxygen
run: sudo apt-get install doxygen graphviz -y
shell: bash

- name: Configure CMake
run: |
cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} \
-Denable-doxygen-doc=ON \
-Denable-parallel-stl-algorithms=OFF

- name: Generate doxygen
run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} --target doc-html

- name: Deploy
uses: peaceiris/actions-gh-pages@v4
with:
personal_token: ${{ secrets.DEPLOY_TO_THELFER_GITHUB_IO }}
publish_branch: master
publish_dir: ${{github.workspace}}/build/docs/doxygen/html/
external_repository: thelfer/thelfer.github.io
destination_dir: mgis/doxygen/
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ if(enable-doxygen-doc)
list(APPEND CPACK_COMPONENTS_ALL doxygen)
set(CPACK_COMPONENT_DOXYGEN_DESCRIPTION
"Contains MGIS' doxygen documentation")
set(GENERATE_DOXYGEN ON)
set(MGIS_GENERATE_DOXYGEN ON)
else(DOXYGEN_FOUND)
message(FATAL_ERROR "doxygen is required")
endif(DOXYGEN_FOUND)
Expand Down
36 changes: 4 additions & 32 deletions Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = @PACKAGE_NAME@
PROJECT_NAME = MGIS

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand Down Expand Up @@ -1117,7 +1117,7 @@ HTML_STYLESHEET =
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_STYLESHEET =
HTML_EXTRA_STYLESHEET = @PROJECT_SOURCE_DIR@/docs/doxygen/doxygen-awesome-css/doxygen-awesome.css

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand All @@ -1129,35 +1129,7 @@ HTML_EXTRA_STYLESHEET =

HTML_EXTRA_FILES =

# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_COLORSTYLE_HUE = 220

# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_COLORSTYLE_SAT = 100

# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
# gradually make the output lighter, whereas values above 100 make the output
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_COLORSTYLE_GAMMA = 80
HTML_COLORSTYLE = LIGHT

# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
Expand Down Expand Up @@ -1403,7 +1375,7 @@ DISABLE_INDEX = NO
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.

GENERATE_TREEVIEW = NO
GENERATE_TREEVIEW = YES

# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
Expand Down
4 changes: 4 additions & 0 deletions docs/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
if(MGIS_GENERATE_DOXYGEN)
add_subdirectory(doxygen)
endif(MGIS_GENERATE_DOXYGEN)

if(MGIS_GENERATE_WEBSITE)
add_subdirectory(web)
endif(MGIS_GENERATE_WEBSITE)
17 changes: 17 additions & 0 deletions docs/doxygen/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
if(MGIS_APPEND_SUFFIX)
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
DESTINATION share/doc/mgis-${MGIS_SUFFIX}
COMPONENT doxygen)
install(FILES
${PROJECT_SOURCE_DIR}/docs/doxygen/img/background.svg
DESTINATION share/doc/mgis-${MGIS_SUFFIX}/html/img/
COMPONENT doxygen)
else(MGIS_APPEND_SUFFIX)
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
DESTINATION share/doc/mgis
COMPONENT doxygen)
install(FILES
${PROJECT_SOURCE_DIR}/docs/doxygen/img/background.svg
DESTINATION share/doc/mgis/html/img/
COMPONENT doxygen)
endif(MGIS_APPEND_SUFFIX)
3 changes: 3 additions & 0 deletions docs/doxygen/doxygen-awesome-css/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!doxygen-awesome*

Loading