Doc

femtotrader · Apr 28, 2024 · ee6a0ec · ee6a0ec
1 parent 5017030
commit ee6a0ec
Show file tree

Hide file tree

Showing 10 changed files with 357 additions and 187 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -6,6 +6,11 @@ makedocs(
     sitename = "OnlinePortfolioAnalytics.jl",
     format = Documenter.HTML(),
     modules = [OnlinePortfolioAnalytics],
-    pages = ["Home" => "index.md", "Usage" => "usage.md", "API" => "api.md"],
+    pages = [
+        "Home" => "index.md",
+        "Usage" => "usage.md",
+        "Examples" => "examples.md",
+        "API" => "api.md",
+    ],
 )
 deploydocs(; repo = "github.com/femtotrader/OnlinePortfolioAnalytics.jl")
diff --git a/docs/src/examples.md b/docs/src/examples.md
@@ -0,0 +1,31 @@
+# Examples
+
+## Sample notebook
+
+### Random prices
+
+![prices](screenshots/prices.png)
+
+### Cumulative returns
+
+![cum_returns](screenshots/cum_returns.png)
+
+### Drawdowns
+
+![drawdowns](screenshots/drawdowns.png)
+
+### Returns
+
+#### Yearly
+
+![prices](screenshots/prices.png)
+
+#### Monthly
+
+![monthly_returns_heatmap](screenshots/monthly_returns_heatmap.png)
+
+![monthly_returns_spiral](screenshots/monthly_returns_spiral.png)
+
+### Download
+
+- [Pluto notebook](https://github.com/femtotrader/OnlinePortfolioAnalytics.jl/blob/main/examples/notebooks/teardown.jl)
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -34,6 +34,7 @@ See [unit tests](https://github.com/femtotrader/OnlinePortfolioAnalytics.jl/tree
 Pages = [
     "index.md",
     "usage.md",
+    "examples.md",
     "api.md"
 ]
 ```
diff --git a/docs/src/screenshots/cum_returns.png b/docs/src/screenshots/cum_returns.png
diff --git a/docs/src/screenshots/drawdowns.png b/docs/src/screenshots/drawdowns.png
diff --git a/docs/src/screenshots/monthly_returns_heatmap.png b/docs/src/screenshots/monthly_returns_heatmap.png
diff --git a/docs/src/screenshots/monthly_returns_spiral.png b/docs/src/screenshots/monthly_returns_spiral.png
diff --git a/docs/src/screenshots/prices.png b/docs/src/screenshots/prices.png
diff --git a/docs/src/screenshots/yearly_returns.png b/docs/src/screenshots/yearly_returns.png