Skip to content

Commit 85d6cf7

Browse files
authored
Fix docs (#215)
* Ignore google test templates in the docs * Include gtest_main * Exclude symlinks * Exclude googletest from documentation
1 parent 4a186c4 commit 85d6cf7

3 files changed

Lines changed: 10 additions & 9 deletions

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ on:
55
push:
66
branches:
77
- main
8+
- fix_docs
89

910
jobs:
1011
publish:

docs/Doxyfile.in

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -845,9 +845,9 @@ RECURSIVE = YES
845845
# run.
846846

847847
EXCLUDE = @CMAKE_CURRENT_SOURCE_DIR@/../src \
848-
@CMAKE_CURRENT_SOURCE_DIR@/../tests \
849-
@CMAKE_CURRENT_SOURCE_DIR@/../tutorials \
850-
@CMAKE_CURRENT_SOURCE_DIR@/../nn_train \
848+
@CMAKE_CURRENT_SOURCE_DIR@/../tests \
849+
@CMAKE_CURRENT_SOURCE_DIR@/../tutorials \
850+
@CMAKE_CURRENT_SOURCE_DIR@/../nn_train \
851851
@CMAKE_CURRENT_SOURCE_DIR@/../swig \
852852
@CMAKE_CURRENT_SOURCE_DIR@/../build \
853853
@CMAKE_CURRENT_SOURCE_DIR@/../cmake \
@@ -859,7 +859,7 @@ EXCLUDE = @CMAKE_CURRENT_SOURCE_DIR@/../src \
859859
# from the input.
860860
# The default value is: NO.
861861

862-
EXCLUDE_SYMLINKS = NO
862+
EXCLUDE_SYMLINKS = YES
863863

864864
# If the value of the INPUT tag contains directories, you can use the
865865
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
@@ -868,7 +868,7 @@ EXCLUDE_SYMLINKS = NO
868868
# Note that the wildcards are matched against the file with absolute path, so to
869869
# exclude all test directories for example use the pattern */test/*
870870

871-
EXCLUDE_PATTERNS =
871+
EXCLUDE_PATTERNS = */gtest/* */gmock/* */testing/internal/* */googletest/*
872872

873873
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
874874
# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -879,13 +879,13 @@ EXCLUDE_PATTERNS =
879879
# Note that the wildcards are matched against the file with absolute path, so to
880880
# exclude all test directories use the pattern */test/*
881881

882-
EXCLUDE_SYMBOLS =
882+
EXCLUDE_SYMBOLS =
883883

884884
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
885885
# that contain example code fragments that are included (see the \include
886886
# command).
887887

888-
EXAMPLE_PATH =
888+
EXAMPLE_PATH =
889889

890890
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
891891
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -2060,7 +2060,7 @@ SEARCH_INCLUDES = YES
20602060
# preprocessor.
20612061
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
20622062

2063-
INCLUDE_PATH =
2063+
INCLUDE_PATH =
20642064

20652065
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
20662066
# patterns (like *.h and *.hpp) to filter out the header-files in the

tests/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ target_link_libraries(
2626
unittests
2727
PUBLIC
2828
Fields2Cover
29-
gtest
29+
GTest::gtest GTest::gtest_main
3030
)
3131

3232
add_test(

0 commit comments

Comments
 (0)