feat: update docs

Bisonai · Jul 18, 2024 · 42ebcbb · 42ebcbb
1 parent afe273f
commit 42ebcbb
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -62,7 +62,7 @@ All clients accept the same parameters that are described at [Configuration](#co
 First, import the clients,
 
 ```python
-# Main client
+# Main client to access crypto trading data
 from datamaxi.datamaxi import Datamaxi
 
 # DeFi

diff --git a/datamaxi/datamaxi/candle.py b/datamaxi/datamaxi/candle.py
@@ -18,7 +18,9 @@ def __init__(self, api_key=None, **kwargs: Any):
         super().__init__(api_key, **kwargs)
 
     def exchanges(self, market: str = "spot") -> List[str]:
-        """Fetch supported exchanges accepted by `datamaxi.candle` API
+        """Fetch supported exchanges accepted by
+        [datamaxi.Candle.get](./#datamaxi.datamaxi.Candle.get)
+        API.
 
         `GET /v1/candle/exchanges`
 
@@ -40,7 +42,9 @@ def exchanges(self, market: str = "spot") -> List[str]:
         return self.query(url_path, params)
 
     def symbols(self, exchange: str, market: str = "spot") -> List[str]:
-        """Fetch supported symbols accepted by `datamaxi.candle` API
+        """Fetch supported symbols accepted by
+        [datamaxi.Candle.get](./#datamaxi.datamaxi.Candle.get)
+        API.
 
         `GET /v1/candle/symbols`
 
@@ -68,7 +72,9 @@ def symbols(self, exchange: str, market: str = "spot") -> List[str]:
         return self.query(url_path, params)
 
     def intervals(self, exchange: str, market: str = "spot") -> List[str]:
-        """Fetch supported intervals accepted by `datamaxi.candle` API
+        """Fetch supported intervals accepted by
+        [datamaxi.Candle.get](./#datamaxi.datamaxi.Candle.get)
+        API.
 
         `GET /v1/candle/intervals`
 

diff --git a/datamaxi/datamaxi/funding_rate.py b/datamaxi/datamaxi/funding_rate.py
@@ -18,7 +18,9 @@ def __init__(self, api_key=None, **kwargs: Any):
         super().__init__(api_key, **kwargs)
 
     def exchanges(self) -> List[str]:
-        """Fetch supported exchanges accepted by `datamaxi.funding_rate` API
+        """Fetch supported exchanges accepted by
+        [datamaxi.FundingRate.get](./#datamaxi.datamaxi.FundingRate.get)
+        API.
 
         `GET /v1/funding-rate/exchanges`
 
@@ -31,7 +33,9 @@ def exchanges(self) -> List[str]:
         return self.query(url_path)
 
     def symbols(self, exchange: str, market: str = "spot") -> List[str]:
-        """Fetch supported symbols accepted by `datamaxi.funding_rate` API
+        """Fetch supported symbols accepted by
+        [datamaxi.FundingRate.get](./#datamaxi.datamaxi.FundingRate.get)
+        API.
 
         `GET /v1/funding-rate/symbols`
 

diff --git a/docs/candle.md b/docs/candle.md
@@ -0,0 +1,6 @@
+# Candle
+
+::: datamaxi.datamaxi.Candle
+    options:
+      show_submodules: true
+      show_source: false
diff --git a/docs/datamaxi.md b/docs/datamaxi.md
diff --git a/docs/funding-rate.md b/docs/funding-rate.md
@@ -0,0 +1,6 @@
+# Funding Rate
+
+::: datamaxi.datamaxi.FundingRate
+    options:
+      show_submodules: true
+      show_source: false
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -30,7 +30,9 @@ markdown_extensions:
 nav:
   - Main: index.md
   - API: api.md
-  - Trading Data: datamaxi.md
+  - Datamaxi:
+      - Candle: candle.md
+      - Funding Rate: funding-rate.md
   - Defillama: defillama.md
   - Trend:
       - Naver Trend: naver-trend.md