deterministic_gaussian_sampling_py/Doxyfile at main · KIT-ISAS/deterministic_gaussian_sampling_py · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
#---------------------------------------------------------------------------
# Project
#---------------------------------------------------------------------------

PROJECT_NAME           = "Deterministic Gaussian Sampling (Python API)"
PROJECT_BRIEF          = "Python bindings for deterministic Gaussian sampling and Dirac mixture reduction."
PROJECT_NUMBER         =
OUTPUT_DIRECTORY       = doxygen
OUTPUT_LANGUAGE        = English
USE_MDFILE_AS_MAINPAGE = README.md

#---------------------------------------------------------------------------
# Python Configuration
#---------------------------------------------------------------------------

OPTIMIZE_OUTPUT_JAVA   = YES
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_FOR_FORTRAN   = NO

PYTHON_DOCSTRING       = NO     # Allows use of Doxygen commands inside docstrings
JAVADOC_AUTOBRIEF      = YES
MULTILINE_CPP_IS_BRIEF = YES

#---------------------------------------------------------------------------
# Input
#---------------------------------------------------------------------------

INPUT                  = src doxygen .
FILE_PATTERNS          = *.py *.md *.dox
RECURSIVE              = YES

EXCLUDE                = build venv .venv .github .vscode tests
EXCLUDE_PATTERNS       = */__pycache__/*

#---------------------------------------------------------------------------
# Extraction
#---------------------------------------------------------------------------

EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = NO
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO

#---------------------------------------------------------------------------
# Source Browser
#---------------------------------------------------------------------------

SOURCE_BROWSER         = YES
INLINE_SOURCES         = NO
REFERENCES_RELATION    = YES
REFERENCED_BY_RELATION = YES

#---------------------------------------------------------------------------
# HTML Output
#---------------------------------------------------------------------------

GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_COLORSTYLE        = AUTO_LIGHT
GENERATE_TREEVIEW      = YES
FULL_SIDEBAR           = YES
SEARCHENGINE           = YES

#---------------------------------------------------------------------------
# Graphs (Optional)
#---------------------------------------------------------------------------

HAVE_DOT               = YES
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = YES
CALL_GRAPH             = NO
CALLER_GRAPH           = NO

DOT_IMAGE_FORMAT       = svg
INTERACTIVE_SVG        = YES

#---------------------------------------------------------------------------
# LaTeX / Other Formats Disabled
#---------------------------------------------------------------------------

GENERATE_LATEX         = NO
GENERATE_XML           = NO
GENERATE_RTF           = NO
GENERATE_MAN           = NO
GENERATE_DOCBOOK       = NO

#---------------------------------------------------------------------------
# Warnings
#---------------------------------------------------------------------------

WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_IF_INCOMPLETE_DOC = YES