Skip to content

Commit 31952dc

Browse files
committed
docs: Add code documentation
Signed-off-by: Sietze van Buuren <s.van.buuren@gmail.com>
1 parent 6c84dd9 commit 31952dc

File tree

4 files changed

+34
-5
lines changed

4 files changed

+34
-5
lines changed

.github/workflows/docs.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,6 @@ jobs:
2727
path: .cache
2828
restore-keys: |
2929
mkdocs-material-
30-
- run: pip install mkdocs-material mkdocstrings[python] pymdown-extensions
30+
- run: pip install mkdocs-material mkdocstrings[python] pymdown-extensions mkdoxy
31+
- run: sudo apt install doxygen
3132
- run: mkdocs gh-deploy --force

docs/reference/index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# Code reference
22

3-
!!! info
4-
5-
Still under construction! Sorry!!
3+
This section contains generated code documentation for `cubinterpp`.

docs/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ library in a python environment.
55

66
## Prerequisites
77

8-
Refer to [installation prerequisites](../requirements/#installation-prerequisites).
8+
Refer to [installation prerequisites](requirements.md#installation-prerequisites).
99

1010
## Building
1111

mkdocs.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ plugins:
1919
python:
2020
options:
2121
show_root_toc_entry: false
22+
- mkdoxy:
23+
projects:
24+
reference:
25+
src-dirs: include/ src/
26+
full-doc: True
27+
doxy-cfg:
28+
FILE_PATTERNS: "*.cpp *.h*"
29+
EXAMPLE_PATH: examples
30+
RECURSIVE: True
2231

2332
markdown_extensions:
2433
- attr_list
@@ -56,3 +65,24 @@ nav:
5665
- Cubic interpolation: theory/cubic.md
5766
- Code Reference:
5867
- reference/index.md
68+
- Links: reference/links.md
69+
- Classes:
70+
- Class List: reference/annotated.md
71+
- Class Index: reference/classes.md
72+
- Class Hierarchy: reference/hierarchy.md
73+
- Class Members: reference/class_members.md
74+
- Class Member Functions: reference/class_member_functions.md
75+
- Class Member Variables: reference/class_member_variables.md
76+
- Class Member Typedefs: reference/class_member_typedefs.md
77+
- Class Member Enumerations: reference/class_member_enums.md
78+
- Namespaces:
79+
- Namespace List: reference/namespaces.md
80+
- Namespace Members: reference/namespace_members.md
81+
- Namespace Member Functions: reference/namespace_member_functions.md
82+
- Namespace Member Variables: reference/namespace_member_variables.md
83+
- Namespace Member Typedefs: reference/namespace_member_typedefs.md
84+
- Namespace Member Enumerations: reference/namespace_member_enums.md
85+
- Functions: reference/functions.md
86+
- Variables: reference/variables.md
87+
- Macros: reference/macros.md
88+
- Files: reference/files.md

0 commit comments

Comments
 (0)