Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
E
eicd
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
EIC
eicd
Commits
21f28d7f
Commit
21f28d7f
authored
2 years ago
by
Wouter Deconinck
Browse files
Options
Downloads
Patches
Plain Diff
feat: make doxygen in github
parent
0f9cb894
Branches
Branches containing commit
No related tags found
1 merge request
!93
feat: make doxygen in github
Pipeline
#35868
failed
2 years ago
Stage: config
Stage: build
Stage: deploy
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
.github/workflows/linux-lcg.yml
+32
-0
32 additions, 0 deletions
.github/workflows/linux-lcg.yml
CMakeLists.txt
+17
-7
17 additions, 7 deletions
CMakeLists.txt
docs/Doxyfile.in
+11
-12
11 additions, 12 deletions
docs/Doxyfile.in
with
60 additions
and
19 deletions
.github/workflows/linux-lcg.yml
0 → 100644
+
32
−
0
View file @
21f28d7f
name
:
linux-lcg
on
:
push
:
branches
:
-
master
jobs
:
build-lcg-docs
:
runs-on
:
ubuntu-20.04
strategy
:
fail-fast
:
false
matrix
:
LCG
:
[
"
LCG_101/x86_64-ubuntu2004-gcc9-opt"
]
steps
:
-
uses
:
actions/checkout@v3
-
uses
:
cvmfs-contrib/github-action-cvmfs@v2
with
:
cvmfs_repositories
:
'
sft.cern.ch,geant4.cern.ch'
-
uses
:
aidasoft/run-lcg-view@v1
with
:
release-platform
:
${{ matrix.LCG }}
run
:
|
PREFIX=${PWD}/install
cmake -B build -S . -DCMAKE_INSTALL_PREFIX=${PREFIX}
cmake --build build -- install
cmake --build build -- docs
-
uses
:
actions/upload-artifact@v3
with
:
name
:
build-lcg-docs
path
:
build/docs/html/
if-no-files-found
:
error
This diff is collapsed.
Click to expand it.
CMakeLists.txt
+
17
−
7
View file @
21f28d7f
...
@@ -65,13 +65,23 @@ install(FILES
...
@@ -65,13 +65,23 @@ install(FILES
"
${
PROJECT_BINARY_DIR
}
/libeicdDict_rdict.pcm"
"
${
PROJECT_BINARY_DIR
}
/libeicdDict_rdict.pcm"
DESTINATION
"
${
CMAKE_INSTALL_LIBDIR
}
"
COMPONENT dev
)
DESTINATION
"
${
CMAKE_INSTALL_LIBDIR
}
"
COMPONENT dev
)
add_custom_target
(
doc_doxygen
#ALL
# -------------------------
COMMAND doxygen
${
CMAKE_SOURCE_DIR
}
/docs/Doxyfile
# install class documentation
WORKING_DIRECTORY
${
CMAKE_BINARY_DIR
}
COMMENT
"Generating API documentation with Doxygen"
find_package
(
Doxygen COMPONENTS dot
)
VERBATIM
)
if
(
DOXYGEN_FOUND
)
configure_file
(
${
CMAKE_SOURCE_DIR
}
/docs/Doxyfile.in
${
CMAKE_CURRENT_BINARY_DIR
}
/Doxyfile
@ONLY
)
add_custom_target
(
docs ALL
COMMAND doxygen
${
CMAKE_CURRENT_BINARY_DIR
}
/Doxyfile
WORKING_DIRECTORY
${
CMAKE_CURRENT_SOURCE_DIR
}
COMMENT
"Generating API documentation with Doxygen"
VERBATIM
)
else
()
message
(
STATUS
"Doxygen not found; no documentation will be built."
)
endif
()
# -------------------------
# -------------------------
# install library config
# install library config
...
...
This diff is collapsed.
Click to expand it.
docs/Doxyfile
→
docs/Doxyfile
.in
+
11
−
12
View file @
21f28d7f
...
@@ -58,7 +58,7 @@ PROJECT_BRIEF = "EIC data model"
...
@@ -58,7 +58,7 @@ PROJECT_BRIEF = "EIC data model"
# entered, it will be relative to the location where doxygen was started. If
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
# left blank the current directory will be used.
OUTPUT_DIRECTORY = docs
OUTPUT_DIRECTORY =
@CMAKE_CURRENT_BINARY_DIR@/
docs
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# 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
# directories (in 2 levels) under the output directory of each output format and
...
@@ -864,11 +864,10 @@ WARN_LOGFILE =
...
@@ -864,11 +864,10 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
# Note: If this tag is empty the current directory is searched.
INPUT = src \
INPUT = README.md \
eicd \
@CMAKE_CURRENT_BINARY_DIR@/src \
../README.md \
@CMAKE_CURRENT_BINARY_DIR@/eicd \
../source \
@CMAKE_CURRENT_BINARY_DIR@/utils
page.dox
# This tag can be used to specify the character encoding of the source files
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
...
@@ -989,7 +988,7 @@ EXCLUDE_SYMBOLS =
...
@@ -989,7 +988,7 @@ EXCLUDE_SYMBOLS =
# that contain example code fragments that are included (see the \include
# that contain example code fragments that are included (see the \include
# command).
# command).
EXAMPLE_PATH = .
./.
EXAMPLE_PATH = .
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
...
@@ -1065,7 +1064,7 @@ FILTER_SOURCE_PATTERNS =
...
@@ -1065,7 +1064,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE =
..
/README.md
USE_MDFILE_AS_MAINPAGE =
@CMAKE_CURRENT_SOURCE_DIR@
/README.md
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
# Configuration options related to source browsing
# Configuration options related to source browsing
...
@@ -1252,7 +1251,7 @@ HTML_FILE_EXTENSION = .html
...
@@ -1252,7 +1251,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER = doxygen-custom/header.html
HTML_HEADER =
docs/
doxygen-custom/header.html
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# generated HTML page. If the tag is left blank doxygen will generate a standard
...
@@ -1287,9 +1286,9 @@ HTML_STYLESHEET =
...
@@ -1287,9 +1286,9 @@ HTML_STYLESHEET =
# list). For an example see the documentation.
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET = doxygen-awesome.css \
HTML_EXTRA_STYLESHEET =
docs/
doxygen-awesome.css \
doxygen-awesome-sidebar-only.css \
docs/
doxygen-awesome-sidebar-only.css \
doxygen-custom/custom.css
docs/
doxygen-custom/custom.css
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# 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
# other source files which should be copied to the HTML output directory. Note
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment