Skip to content

Commit 6d4dc1b

Browse files
authored
Use <code> block, add docs (#3)
* Swap to encoding code block in `<code>` tags which seem more robust. * Add more documentation.
1 parent 242091c commit 6d4dc1b

File tree

8 files changed

+870
-170
lines changed

8 files changed

+870
-170
lines changed

docs/source/api.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,11 @@ The main **Kork** API is shown here:
1313

1414
CodeChain
1515
AstPrinter
16-
AbstractRetriever
17-
SimpleRetriever
16+
AbstractContextRetriever
17+
SimpleContextRetriever
18+
AbstractExampleRetriever
19+
SimpleExampleRetriever
20+
1821

1922

2023
Kork Interpreter
@@ -25,6 +28,7 @@ Kork Interpreter
2528
InterpreterResult
2629
run_interpreter
2730
Environment
31+
KorkException
2832

2933

3034
Index

docs/source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ retrievers
9191
```{toctree}
9292
:caption: Examples
9393
calculator
94+
query_analyzer
9495
```
9596

9697
```{toctree}

docs/source/introduction.ipynb

Lines changed: 287 additions & 148 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)