Link to API docs from readme (#582)

SleipnirGroup · Jun 29, 2024 · f2f3861 · f2f3861
1 parent 870d43e
commit f2f3861
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -112,6 +112,10 @@ See the [build instructions](https://github.com/SleipnirGroup/Sleipnir/?tab=read
 pip install sleipnirgroup-jormungandr
 ```
 
+## API docs
+
+See the [C++ API docs](https://sleipnirgroup.github.io/Sleipnir/docs/cpp) and [Python API docs](https://sleipnirgroup.github.io/Sleipnir/docs/py).
+
 ## Examples
 
 See the [examples](https://github.com/SleipnirGroup/Sleipnir/tree/main/examples), [C++ optimization unit tests](https://github.com/SleipnirGroup/Sleipnir/tree/main/test/optimization), and [Python optimization unit tests](https://github.com/SleipnirGroup/Sleipnir/tree/main/jormungandr/test/optimization).