Skip to content

Commit e79f47f

Browse files
committed
Initial documentation configuration and sample text
1 parent 984ea05 commit e79f47f

File tree

3 files changed

+34
-0
lines changed

3 files changed

+34
-0
lines changed

doc/about.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# About this code
2+
3+
Work in progress ...

doc/conf.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
project = "Collaborative Coding Exam"
2+
copyright = "2025, SFI Visual Intelligence"
3+
author = "SFI Visual Intelligence"
4+
release = "0.0.1"
5+
6+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
7+
8+
extensions = [
9+
"myst_parser", # in order to use markdown
10+
]
11+
12+
myst_enable_extensions = [
13+
"colon_fence", # ::: can be used instead of ``` for better rendering
14+
]
15+
16+
html_theme = "sphinx_rtd_theme"

doc/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Our code documentation
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
4+
incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
5+
nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
6+
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
7+
fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
8+
culpa qui officia deserunt mollit anim id est laborum.
9+
10+
:::{toctree}
11+
:maxdepth: 2
12+
:caption: Some caption
13+
14+
about.md
15+
:::

0 commit comments

Comments
 (0)