Skip to content

Commit

Permalink
faet: update docs with candle split (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
martinkersner authored Sep 24, 2024
1 parent a0ad115 commit e0944e7
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 4 deletions.
3 changes: 3 additions & 0 deletions datamaxi/datamaxi/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions docs/candle.md → docs/cex-candle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Candle
# CEX Candle

::: datamaxi.datamaxi.Candle
::: datamaxi.datamaxi.CexCandle
options:
show_submodules: true
show_source: false
6 changes: 6 additions & 0 deletions docs/dex-candle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# DEX Candle

::: datamaxi.datamaxi.DexCandle
options:
show_submodules: true
show_source: false
6 changes: 4 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e0944e7

Please sign in to comment.