Terminal Docs Auto Generation (#3438)

* init

* Update generate_terminal_markdown.py

* Update generate_terminal_markdown.py

* moved folders out of common into root

* remove cat from trail if sub in [ ba, ta, qa ]

* Update generate_terminal_markdown.py

* un-indented example images

* Update generate_terminal_markdown.py

* Update generate_terminal_markdown.py

* Update generate_terminal_markdown.py

* replace ✨ with 🦋

* Update regression_model.py

* updates

* up

* fix missing type hints, added defaults to sdk generation

* typing

* typing

* datetime defaults, fix dict_keys([]) in choices

* fix regression docstring, added divider on markdowns

* fix get_hcp portfolio trailmap

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* Update generate_sdk_markdown.py

* Update .gitignore

* Making it more 3.9 friendly

* Update controller_doc_classes.py

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: Chavithra <chavithra@gmail.com>

.gitignore

@@ -30,7 +30,7 @@ openbb_terminal/portfolio/portfolios/*
 .coverage.*
 !openbb_terminal/reports/templates/*.ipynb
 *_tests.csv
-*_sdk_audit.csv
+website/terminaltest
 
 # pyinstaller artifacts
 *.pyo

openbb_terminal/cryptocurrency/due_diligence/coinpaprika_model.py

@@ -72,7 +72,7 @@ def get_coin_twitter_timeline(
 
 @log_start_end(log=logger)
 def get_coin_events_by_id(
-    symbol: str = "BTC", sortby="date", ascend: bool = False
+    symbol: str = "BTC", sortby: str = "date", ascend: bool = False
 ) -> pd.DataFrame:
     """Get all events related to given coin like conferences, start date of futures trading etc.
     [Source: CoinPaprika]

openbb_terminal/cryptocurrency/nft/nftpricefloor_model.py

@@ -43,7 +43,7 @@ def get_collections() -> pd.DataFrame:
 
 
 @log_start_end(log=logger)
-def get_floor_price(slug) -> pd.DataFrame:
+def get_floor_price(slug: str) -> pd.DataFrame:
     """Get nft collections [Source: https://nftpricefloor.com/]
 
     Parameters

openbb_terminal/cryptocurrency/onchain/bitquery_view.py

@@ -285,7 +285,7 @@ def display_ethereum_unique_senders(
 @log_start_end(log=logger)
 @check_api_key(["API_BITQUERY_KEY"])
 def display_most_traded_pairs(
-    exchange="Uniswap",
+    exchange: str = "Uniswap",
     days: int = 10,
     limit: int = 10,
     sortby: str = "tradeAmount",
@@ -297,16 +297,17 @@ def display_most_traded_pairs(
 
     Parameters
     ----------
-    exchange:
+    exchange: str
         Decentralized exchange name
-    days:
+    days: int
         Number of days taken into calculation account.
     sortby: str
         Key by which to sort data
     ascend: bool
         Flag to sort data ascending
     export : str
         Export dataframe data to csv,json,xlsx file
+
     Returns
     -------
     pd.DataFrame
@@ -344,8 +345,8 @@ def display_most_traded_pairs(
 @log_start_end(log=logger)
 @check_api_key(["API_BITQUERY_KEY"])
 def display_spread_for_crypto_pair(
-    symbol="WETH",
-    to_symbol="USDT",
+    symbol: str = "WETH",
+    to_symbol: str = "USDT",
     limit: int = 10,
     sortby: str = "date",
     ascend: bool = True,

openbb_terminal/cryptocurrency/onchain/ethplorer_model.py

@@ -303,7 +303,7 @@ def get_top_tokens(sortby: str = "rank", ascend: bool = False) -> pd.DataFrame:
 
 @log_start_end(log=logger)
 def get_top_token_holders(
-    address, sortby: str = "balance", ascend: bool = True
+    address: str, sortby: str = "balance", ascend: bool = True
 ) -> pd.DataFrame:
     """Get info about top token holders. [Source: Ethplorer]
 
@@ -334,7 +334,7 @@ def get_top_token_holders(
 
 @log_start_end(log=logger)
 def get_address_history(
-    address, sortby: str = "timestamp", ascend: bool = True
+    address: str, sortby: str = "timestamp", ascend: bool = True
 ) -> pd.DataFrame:
     """Get information about balance historical transactions. [Source: Ethplorer]
 
@@ -441,7 +441,7 @@ def get_token_info(address) -> pd.DataFrame:
 
 
 @log_start_end(log=logger)
-def get_tx_info(tx_hash) -> pd.DataFrame:
+def get_tx_info(tx_hash: str) -> pd.DataFrame:
     """Get info about transaction. [Source: Ethplorer]
 
     Parameters
@@ -487,7 +487,7 @@ def get_tx_info(tx_hash) -> pd.DataFrame:
 
 @log_start_end(log=logger)
 def get_token_history(
-    address, sortby: str = "timestamp", ascend: bool = False
+    address: str, sortby: str = "timestamp", ascend: bool = False
 ) -> pd.DataFrame:
     """Get info about token historical transactions. [Source: Ethplorer]
 
@@ -543,7 +543,7 @@ def get_token_history(
 
 @log_start_end(log=logger)
 def get_token_historical_price(
-    address,
+    address: str,
     sortby: str = "date",
     ascend: bool = False,
 ) -> pd.DataFrame: