Skip to content

Commit 3bcd905

Browse files
committed
Update documentation with python API docstrings
Signed-off-by: Rahul Krishna <[email protected]>
1 parent 037bfe5 commit 3bcd905

16 files changed

+139
-22
lines changed
40.5 KB
Loading
44.7 KB
Loading
34.6 KB
Loading
36 KB
Loading
34 KB
Loading
35 KB
Loading

docs/core-concepts/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ hide:
55
- toc
66
---
77

8-
To be updated.
8+
To be updated.

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Get started with Codellm-Devkit:
5959

6060
Explore the key components of CLDK—including data models and analysis backends—that simplify code analysis workflows.
6161

62-
- [:cldk-manual-16: API Reference](reference/index.md)
62+
- [:cldk-manual-16: Python API Reference](reference/python-api/index.md)
6363

6464
---
6565

@@ -104,7 +104,7 @@ Dive deeper into advanced topics
104104
Learn how to extend CLDK to a new language.
105105

106106
- [:cldk-workflow-16: Adding a New Analysis Backend](advanced/adding_backend.md)
107-
107+
108108
---
109109

110110
Learn how to add a new analysis backend to CLDK.
@@ -136,4 +136,4 @@ For any questions, feedback, or suggestions, please contact the authors:
136136
| -------------- | ---------------------------------------- |
137137
| Rahul Krishna | [[email protected]](mailto:[email protected]) |
138138
| Rangeet Pan | [[email protected]](mailto:[email protected]) |
139-
| Saurabh Sihna | [[email protected]](mailto:[email protected]) |
139+
| Saurabh Sihna | [[email protected]](mailto:[email protected]) |

docs/reference/index.md

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

docs/reference/python-api/c-cpp.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "C/C++ API"
3+
icon: cldk/manual-20
4+
---
5+
6+
This page documents the C and C++ related APIs in the CLDK library.
7+
8+
Use the table of contents to navigate classes, functions, and submodules exposed under the C/C++ analysis and schema packages.
9+
10+
## Analysis
11+
12+
C/C++ analysis utilities and workflows.
13+
14+
::: cldk.analysis.c.c_analysis
15+
16+
## Schema
17+
18+
Data models used by the C/C++ analyzers.
19+
20+
::: cldk.models.c.models

0 commit comments

Comments
 (0)