Skip to content

Commit b2663ae

Browse files
committed
Add 🥬doc configuration
1 parent 76523b3 commit b2663ae

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

.hdoc.toml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# For use with 🥬doc - https://github.com/celerity/leafy-green-doc
2+
3+
[project]
4+
name = "SimSYCL"
5+
version = "0.1.0"
6+
7+
# Optional, adding this will enable direct links from the documentation
8+
# to your source code.
9+
git_repo_url = "https://github.com/celerity/SimSYCL/"
10+
git_default_branch = "master"
11+
12+
[paths]
13+
compile_commands = "compile_commands.json"
14+
output_dir = "hdoc-output"
15+
16+
[ignore]
17+
paths = [
18+
# various build folders
19+
"/build/",
20+
"/build_",
21+
"/build-",
22+
"/_deps/",
23+
# other code that should be ignored
24+
"test/",
25+
"examples/",
26+
"vendor/",
27+
]
28+
namespaces = [
29+
# nothing in these namspaces is relevant for the user
30+
"env",
31+
"std",
32+
"fmt",
33+
]
34+
35+
[detail]
36+
namespaces = [
37+
"detail",
38+
]
39+
40+
[pages]
41+
homepage = "README.md"
42+
43+
[output]
44+
minimal = false

0 commit comments

Comments
 (0)