Skip to content

Commit 11f754b

Browse files
lucapegolottilucapegolotti
committed
Add documentation
1 parent 6f930eb commit 11f754b

File tree

8 files changed

+3087
-0
lines changed

8 files changed

+3087
-0
lines changed

‎.github/workflows/documentation.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# This workflow builds and deploys the html documentation
2+
name: Documentation
3+
on: [push, pull_request]
4+
permissions:
5+
contents: write
6+
jobs:
7+
documentation:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v3
11+
- name: Build doxygen documentation
12+
run: |
13+
sudo apt install -y doxygen
14+
doxygen doc/Doxyfile
15+
- name: Save documentation
16+
uses: actions/upload-artifact@v3
17+
with:
18+
name: documentation
19+
path: doc/html
20+
- name: Deploy documentation
21+
if: github.ref == 'refs/heads/main'
22+
uses: peaceiris/actions-gh-pages@v3
23+
with:
24+
github_token: ${{ secrets.GITHUB_TOKEN }}
25+
publish_dir: doc/html

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ svresults/
55
extra_data/
66
vmr-pdfs
77
additionaldata
8+
doc/html
9+
doc/latex

‎doc/Doxyfile

+306
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,306 @@
1+
# Doxyfile 1.8.5
2+
3+
#---------------------------------------------------------------------------
4+
# Project related configuration options
5+
#---------------------------------------------------------------------------
6+
DOXYFILE_ENCODING = UTF-8
7+
PROJECT_NAME = svExternals
8+
PROJECT_NUMBER =
9+
PROJECT_BRIEF =
10+
PROJECT_LOGO =
11+
OUTPUT_DIRECTORY = "doc/"
12+
CREATE_SUBDIRS = NO
13+
OUTPUT_LANGUAGE = English
14+
BRIEF_MEMBER_DESC = YES
15+
REPEAT_BRIEF = YES
16+
ABBREVIATE_BRIEF = "The $name class" \
17+
"The $name widget" \
18+
"The $name file" \
19+
is \
20+
provides \
21+
specifies \
22+
contains \
23+
represents \
24+
a \
25+
an \
26+
the
27+
ALWAYS_DETAILED_SEC = YES
28+
INLINE_INHERITED_MEMB = NO
29+
FULL_PATH_NAMES = YES
30+
STRIP_FROM_PATH = "."
31+
STRIP_FROM_INC_PATH =
32+
SHORT_NAMES = NO
33+
JAVADOC_AUTOBRIEF = NO
34+
QT_AUTOBRIEF = NO
35+
MULTILINE_CPP_IS_BRIEF = NO
36+
INHERIT_DOCS = YES
37+
SEPARATE_MEMBER_PAGES = NO
38+
TAB_SIZE = 4
39+
ALIASES =
40+
OPTIMIZE_OUTPUT_FOR_C = NO
41+
OPTIMIZE_OUTPUT_JAVA = NO
42+
OPTIMIZE_FOR_FORTRAN = NO
43+
OPTIMIZE_OUTPUT_VHDL = NO
44+
EXTENSION_MAPPING =
45+
MARKDOWN_SUPPORT = YES
46+
AUTOLINK_SUPPORT = YES
47+
BUILTIN_STL_SUPPORT = YES
48+
CPP_CLI_SUPPORT = NO
49+
SIP_SUPPORT = NO
50+
IDL_PROPERTY_SUPPORT = YES
51+
DISTRIBUTE_GROUP_DOC = NO
52+
SUBGROUPING = YES
53+
INLINE_GROUPED_CLASSES = NO
54+
INLINE_SIMPLE_STRUCTS = NO
55+
TYPEDEF_HIDES_STRUCT = NO
56+
LOOKUP_CACHE_SIZE = 0
57+
#---------------------------------------------------------------------------
58+
# Build related configuration options
59+
#---------------------------------------------------------------------------
60+
EXTRACT_ALL = NO
61+
EXTRACT_PRIVATE = NO
62+
EXTRACT_PACKAGE = NO
63+
EXTRACT_STATIC = NO
64+
EXTRACT_LOCAL_CLASSES = YES
65+
EXTRACT_LOCAL_METHODS = NO
66+
EXTRACT_ANON_NSPACES = NO
67+
HIDE_UNDOC_MEMBERS = NO
68+
HIDE_UNDOC_CLASSES = NO
69+
HIDE_FRIEND_COMPOUNDS = YES
70+
HIDE_IN_BODY_DOCS = NO
71+
INTERNAL_DOCS = NO
72+
CASE_SENSE_NAMES = NO
73+
HIDE_SCOPE_NAMES = NO
74+
SHOW_INCLUDE_FILES = YES
75+
FORCE_LOCAL_INCLUDES = NO
76+
INLINE_INFO = YES
77+
SORT_MEMBER_DOCS = YES
78+
SORT_BRIEF_DOCS = NO
79+
SORT_MEMBERS_CTORS_1ST = NO
80+
SORT_GROUP_NAMES = NO
81+
SORT_BY_SCOPE_NAME = NO
82+
STRICT_PROTO_MATCHING = NO
83+
GENERATE_TODOLIST = YES
84+
GENERATE_TESTLIST = YES
85+
GENERATE_BUGLIST = YES
86+
GENERATE_DEPRECATEDLIST= YES
87+
ENABLED_SECTIONS =
88+
MAX_INITIALIZER_LINES = 30
89+
SHOW_USED_FILES = YES
90+
SHOW_FILES = YES
91+
SHOW_NAMESPACES = YES
92+
FILE_VERSION_FILTER =
93+
LAYOUT_FILE = ./doc/layout.xml
94+
CITE_BIB_FILES = ./doc/references.bib
95+
#---------------------------------------------------------------------------
96+
# Configuration options related to warning and progress messages
97+
#---------------------------------------------------------------------------
98+
QUIET = NO
99+
WARNINGS = YES
100+
WARN_IF_UNDOCUMENTED = YES
101+
WARN_IF_DOC_ERROR = YES
102+
WARN_NO_PARAMDOC = YES
103+
WARN_FORMAT = "$file:$line: $text"
104+
WARN_LOGFILE =
105+
#---------------------------------------------------------------------------
106+
# Configuration options related to the input files
107+
#---------------------------------------------------------------------------
108+
INPUT = "doc/pages"
109+
INPUT_ENCODING = UTF-8
110+
FILE_PATTERNS = *.md \
111+
RECURSIVE = YES
112+
EXCLUDE =
113+
EXCLUDE_SYMLINKS = NO
114+
EXCLUDE_PATTERNS =
115+
EXCLUDE_SYMBOLS =
116+
EXAMPLE_PATH =
117+
EXAMPLE_PATTERNS = *
118+
EXAMPLE_RECURSIVE = NO
119+
IMAGE_PATH =
120+
INPUT_FILTER =
121+
FILTER_PATTERNS =
122+
FILTER_SOURCE_FILES = NO
123+
FILTER_SOURCE_PATTERNS =
124+
USE_MDFILE_AS_MAINPAGE = doc/pages/main.md
125+
#---------------------------------------------------------------------------
126+
# Configuration options related to source browsing
127+
#---------------------------------------------------------------------------
128+
SOURCE_BROWSER = NO
129+
INLINE_SOURCES = NO
130+
STRIP_CODE_COMMENTS = NO
131+
REFERENCED_BY_RELATION = NO
132+
REFERENCES_RELATION = NO
133+
REFERENCES_LINK_SOURCE = YES
134+
SOURCE_TOOLTIPS = YES
135+
USE_HTAGS = NO
136+
VERBATIM_HEADERS = YES
137+
#---------------------------------------------------------------------------
138+
# Configuration options related to the alphabetical class index
139+
#---------------------------------------------------------------------------
140+
ALPHABETICAL_INDEX = YES
141+
IGNORE_PREFIX =
142+
#---------------------------------------------------------------------------
143+
# Configuration options related to the HTML output
144+
#---------------------------------------------------------------------------
145+
GENERATE_HTML = YES
146+
HTML_OUTPUT = html
147+
HTML_FILE_EXTENSION = .html
148+
HTML_HEADER =
149+
HTML_FOOTER =
150+
HTML_STYLESHEET =
151+
HTML_EXTRA_STYLESHEET = ./doc/doxygen-awesome.css
152+
HTML_EXTRA_FILES =
153+
HTML_COLORSTYLE_HUE = 220
154+
HTML_COLORSTYLE_SAT = 100
155+
HTML_COLORSTYLE_GAMMA = 80
156+
HTML_DYNAMIC_SECTIONS = NO
157+
HTML_INDEX_NUM_ENTRIES = 100
158+
GENERATE_DOCSET = NO
159+
DOCSET_FEEDNAME = "Doxygen generated docs"
160+
DOCSET_BUNDLE_ID = org.doxygen.Project
161+
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
162+
DOCSET_PUBLISHER_NAME = Publisher
163+
GENERATE_HTMLHELP = NO
164+
CHM_FILE =
165+
HHC_LOCATION =
166+
GENERATE_CHI = NO
167+
CHM_INDEX_ENCODING =
168+
BINARY_TOC = NO
169+
TOC_EXPAND = NO
170+
GENERATE_QHP = NO
171+
QCH_FILE =
172+
QHP_NAMESPACE = org.doxygen.Project
173+
QHP_VIRTUAL_FOLDER = doc
174+
QHP_CUST_FILTER_NAME =
175+
QHP_CUST_FILTER_ATTRS =
176+
QHP_SECT_FILTER_ATTRS =
177+
QHG_LOCATION =
178+
GENERATE_ECLIPSEHELP = NO
179+
ECLIPSE_DOC_ID = org.doxygen.Project
180+
DISABLE_INDEX = NO
181+
GENERATE_TREEVIEW = NO
182+
ENUM_VALUES_PER_LINE = 1
183+
TREEVIEW_WIDTH = 250
184+
EXT_LINKS_IN_WINDOW = NO
185+
FORMULA_FONTSIZE = 10
186+
USE_MATHJAX = NO
187+
MATHJAX_FORMAT = HTML-CSS
188+
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
189+
MATHJAX_EXTENSIONS =
190+
MATHJAX_CODEFILE =
191+
SEARCHENGINE = YES
192+
SERVER_BASED_SEARCH = NO
193+
EXTERNAL_SEARCH = NO
194+
SEARCHENGINE_URL =
195+
SEARCHDATA_FILE = searchdata.xml
196+
EXTERNAL_SEARCH_ID =
197+
EXTRA_SEARCH_MAPPINGS =
198+
#---------------------------------------------------------------------------
199+
# Configuration options related to the LaTeX output
200+
#---------------------------------------------------------------------------
201+
GENERATE_LATEX = YES
202+
LATEX_OUTPUT = latex
203+
LATEX_CMD_NAME = latex
204+
MAKEINDEX_CMD_NAME = makeindex
205+
COMPACT_LATEX = NO
206+
PAPER_TYPE = a4
207+
EXTRA_PACKAGES = {tikz} \
208+
{circuitikz} \
209+
{amsmath} \
210+
{amsfonts} \
211+
{amssymb}
212+
LATEX_HEADER =
213+
LATEX_FOOTER =
214+
LATEX_EXTRA_FILES =
215+
PDF_HYPERLINKS = YES
216+
USE_PDFLATEX = YES
217+
LATEX_BATCHMODE = NO
218+
LATEX_HIDE_INDICES = NO
219+
LATEX_BIB_STYLE = plain
220+
#---------------------------------------------------------------------------
221+
# Configuration options related to the RTF output
222+
#---------------------------------------------------------------------------
223+
GENERATE_RTF = NO
224+
RTF_OUTPUT = rtf
225+
COMPACT_RTF = NO
226+
RTF_HYPERLINKS = NO
227+
RTF_STYLESHEET_FILE =
228+
RTF_EXTENSIONS_FILE =
229+
#---------------------------------------------------------------------------
230+
# Configuration options related to the man page output
231+
#---------------------------------------------------------------------------
232+
GENERATE_MAN = NO
233+
MAN_OUTPUT = man
234+
MAN_EXTENSION = .3
235+
MAN_LINKS = NO
236+
#---------------------------------------------------------------------------
237+
# Configuration options related to the XML output
238+
#---------------------------------------------------------------------------
239+
GENERATE_XML = NO
240+
XML_OUTPUT = xml
241+
XML_PROGRAMLISTING = YES
242+
#---------------------------------------------------------------------------
243+
# Configuration options related to the DOCBOOK output
244+
#---------------------------------------------------------------------------
245+
GENERATE_DOCBOOK = NO
246+
DOCBOOK_OUTPUT = docbook
247+
#---------------------------------------------------------------------------
248+
# Configuration options for the AutoGen Definitions output
249+
#---------------------------------------------------------------------------
250+
GENERATE_AUTOGEN_DEF = NO
251+
#---------------------------------------------------------------------------
252+
# Configuration options related to the Perl module output
253+
#---------------------------------------------------------------------------
254+
GENERATE_PERLMOD = NO
255+
PERLMOD_LATEX = NO
256+
PERLMOD_PRETTY = YES
257+
PERLMOD_MAKEVAR_PREFIX =
258+
#---------------------------------------------------------------------------
259+
# Configuration options related to the preprocessor
260+
#---------------------------------------------------------------------------
261+
ENABLE_PREPROCESSING = YES
262+
MACRO_EXPANSION = NO
263+
EXPAND_ONLY_PREDEF = NO
264+
SEARCH_INCLUDES = YES
265+
INCLUDE_PATH =
266+
INCLUDE_FILE_PATTERNS =
267+
PREDEFINED =
268+
EXPAND_AS_DEFINED =
269+
SKIP_FUNCTION_MACROS = YES
270+
#---------------------------------------------------------------------------
271+
# Configuration options related to external references
272+
#---------------------------------------------------------------------------
273+
TAGFILES =
274+
GENERATE_TAGFILE =
275+
ALLEXTERNALS = NO
276+
EXTERNAL_GROUPS = YES
277+
EXTERNAL_PAGES = YES
278+
#---------------------------------------------------------------------------
279+
# Configuration options related to the dot tool
280+
#---------------------------------------------------------------------------
281+
HIDE_UNDOC_RELATIONS = YES
282+
HAVE_DOT = YES
283+
DOT_NUM_THREADS = 0
284+
DOT_FONTPATH =
285+
CLASS_GRAPH = YES
286+
COLLABORATION_GRAPH = NO
287+
GROUP_GRAPHS = YES
288+
UML_LOOK = NO
289+
UML_LIMIT_NUM_FIELDS = 10
290+
TEMPLATE_RELATIONS = NO
291+
INCLUDE_GRAPH = YES
292+
INCLUDED_BY_GRAPH = YES
293+
CALL_GRAPH = NO
294+
CALLER_GRAPH = NO
295+
GRAPHICAL_HIERARCHY = YES
296+
DIRECTORY_GRAPH = YES
297+
DOT_IMAGE_FORMAT = svg
298+
INTERACTIVE_SVG = NO
299+
DOT_PATH =
300+
DOTFILE_DIRS =
301+
MSCFILE_DIRS =
302+
DOT_GRAPH_MAX_NODES = 50
303+
MAX_DOT_GRAPH_DEPTH = 0
304+
DOT_MULTI_TARGETS = NO
305+
GENERATE_LEGEND = YES
306+
DOT_CLEANUP = YES

0 commit comments

Comments
 (0)