Skip to content

Commit fdbc424

Browse files
added initial docs
1. Build instructions 2. Required dependencies 3. Deployment options
1 parent 2a72fb0 commit fdbc424

19 files changed

Lines changed: 6979 additions & 149 deletions

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,8 @@ poc/bpf-core/vmlinux.h
7878
deps
7979

8080
#nfs
81-
*.nfs*
81+
*.nfs*
82+
83+
# Sphinx documentation builds
84+
docs/_build/
85+
docs/_static/__pycache__/

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ add_dependencies(datacrumbs_obj datacrumbs_bpf_skel)
439439

440440
# Build the final executable by linking server.cpp and the object library
441441
add_executable(${PROJECT_NAME} ${DATACRUMBS_SERVER_SRC})
442-
target_link_libraries(${PROJECT_NAME} ${DEPENDENCY_LIB} datacrumbs_obj)
442+
target_link_libraries(${PROJECT_NAME} datacrumbs_obj ${DEPENDENCY_LIB})
443443
add_dependencies(${PROJECT_NAME} datacrumbs_bpf_skel datacrumbs_obj)
444444

445445
# Install the main processing executable into DATACRUMBS_INSTALL_BINARYDIR

docs/DataCrumbs_IPDPS_26-2.pdf

1.05 MB
Binary file not shown.

docs/_static/custom.css

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/* Bullet lists in content area only */
2+
.rst-content ul.simple,
3+
.rst-content .section ul {
4+
list-style: disc outside !important;
5+
margin-left: 0 !important;
6+
padding-left: 1.2em !important;
7+
margin-bottom: 12px !important;
8+
}
9+
10+
.rst-content ul.simple li,
11+
.rst-content .section ul li {
12+
display: list-item !important;
13+
list-style: disc outside !important;
14+
margin-left: 0 !important;
15+
margin-bottom: 0 !important;
16+
}
17+
18+
.rst-content ul.simple li p,
19+
.rst-content .section ul li p {
20+
margin-bottom: 0 !important;
21+
margin-top: 0 !important;
22+
display: inline !important;
23+
}
24+
25+
/* Numbered lists in content area only */
26+
.rst-content ol,
27+
.rst-content .section ol {
28+
list-style: decimal outside !important;
29+
padding-left: 1.5em !important;
30+
margin-bottom: 12px !important;
31+
margin-left: 0 !important;
32+
}
33+
34+
.rst-content ol li,
35+
.rst-content .section ol li {
36+
display: list-item !important;
37+
list-style: decimal outside !important;
38+
margin-bottom: 0 !important;
39+
margin-left: 0 !important;
40+
}
41+
42+
.rst-content ol li p,
43+
.rst-content .section ol li p {
44+
margin-bottom: 0 !important;
45+
margin-top: 0 !important;
46+
display: inline !important;
47+
}
48+
49+
/* Ensure navigation lists have no bullets */
50+
.wy-menu-vertical ul,
51+
.wy-menu-vertical li,
52+
nav ul,
53+
nav li,
54+
.toctree-l1,
55+
.toctree-l2,
56+
.toctree-l3 {
57+
list-style: none !important;
58+
}

docs/app.rst

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)