Merge pull request #100 from auto-differentiation/feature/quantlib-ri…

…sks-docs Quantlib-risks Documentation
auto-differentiation · Mar 25, 2024 · 41af595 · 41af595
2 parents 5098053 + bde7f2b
commit 41af595
Show file tree

Hide file tree

Showing 5 changed files with 142 additions and 83 deletions.
diff --git a/bindings/python/poetry.lock b/bindings/python/poetry.lock
diff --git a/docs/examples/simple_examples.md → docs/examples.md b/docs/examples/simple_examples.md → docs/examples.md
@@ -1,10 +1,11 @@
 ---
 description: >
-  Quick examples for calculating forward, adjoint, and higher order derivatives with the XAD automatic differentiation tool.
+  Examples for calculating forward, adjoint, and higher order derivatives with the XAD automatic differentiation tool.
+hide:
+  - navigation
 ---
 
-
-# Simple Examples
+# Examples
 
 To quickly get an idea how using XAD looks like in practice,
 see the examples below.
@@ -13,7 +14,7 @@ is callable with the active data type for algorithmic differentiation.
 
 Note that XAD ships with a [set of examples](https://github.com/auto-differentiation/XAD/tree/main/samples) that can be used as a starting point for development.
 Further, for examples how to use it with a large-scale project,
-please see [QuantLib Integration](quantlib.md).
+please see [QuantLib Integration](quantlib/cxx.md).
 
 ## First Order Forward Mode
 

diff --git a/docs/examples/quantlib.md → docs/quantlib/cxx.md b/docs/examples/quantlib.md → docs/quantlib/cxx.md
@@ -3,7 +3,7 @@ description: >-
   As a demonstrator for integration with real-world code, as of version 1.28 (October 2022), QuantLib is AAD-enabled with XAD.
 ---
 
-# QuantLib Integration
+# C++ QuantLib Integration
 
 As a demonstrator of integration with real-world code, the latest release of [QuantLib](https://www.quantlib.org) is AAD-enabled with XAD.
 The performance achieved on sample applications is many-fold superior to what has been reported previously with other tools.