faet: update docs with candle split (#59)

Bisonai · Sep 24, 2024 · e0944e7 · e0944e7
1 parent a0ad115
commit e0944e7
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git a/datamaxi/datamaxi/__init__.py b/datamaxi/datamaxi/__init__.py
@@ -6,6 +6,9 @@
 from datamaxi.datamaxi.forex import Forex
 from datamaxi.datamaxi.ticker import Ticker
 from datamaxi.datamaxi.premium import Premium
+from datamaxi.datamaxi.cex_candle import CexCandle  # used in documentation # noqa:F401
+from datamaxi.datamaxi.dex_candle import DexCandle  # used in documentation # noqa:F401
+from datamaxi.datamaxi.dex_trade import DexTrade  # used in documentation # noqa:F401
 
 
 class Datamaxi:

diff --git a/docs/candle.md → docs/cex-candle.md b/docs/candle.md → docs/cex-candle.md
@@ -1,6 +1,6 @@
-# Candle
+# CEX Candle
 
-::: datamaxi.datamaxi.Candle
+::: datamaxi.datamaxi.CexCandle
     options:
       show_submodules: true
       show_source: false
diff --git a/docs/dex-candle.md b/docs/dex-candle.md
@@ -0,0 +1,6 @@
+# DEX Candle
+
+::: datamaxi.datamaxi.DexCandle
+    options:
+      show_submodules: true
+      show_source: false
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -32,9 +32,11 @@ nav:
   - Main: index.md
   - API: api.md
   - Datamaxi:
-      - Candle: candle.md
+      - CEX Candle: cex-candle.md
+      - DEX:
+          - Trade: dex-trade.md
+          - Candle: dex-candle.md
       - Funding Rate: funding-rate.md
-      - DEX Trade: dex-trade.md
       - Forex: forex.md
       - Ticker: ticker.md
       - Premium: premium.md