Fix SDK website documentation script (#3371)

* fix doc generation * remove italic from bool
OpenBB-finance · Nov 10, 2022 · 7895e22 · 7895e22
1 parent fb1392b
commit 7895e22
Show file tree

Hide file tree

Showing 323 changed files with 698 additions and 697 deletions.
diff --git a/website/content/SDK/alt/covid/ov/_index.rst b/website/content/SDK/alt/covid/ov/_index.rst
@@ -31,7 +31,7 @@ alt.covid.ov(
         Country to get data for
     limit: int
         Number of raw data to show
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -71,6 +71,6 @@ alt.covid.ov(
         Format to export data
     plot: bool
         Flag to display historical plot
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/alt/covid/slopes/_index.rst b/website/content/SDK/alt/covid/slopes/_index.rst
@@ -38,7 +38,7 @@ alt.covid.slopes(
         Threshold for total number of cases
     ascend: bool
         Flag to sort in ascending order
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -84,6 +84,6 @@ alt.covid.slopes(
         Threshold for total cases over period
     export : str
         Format to export data
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/alt/covid/stat/_index.rst b/website/content/SDK/alt/covid/stat/_index.rst
@@ -34,7 +34,7 @@ alt.covid.stat(
         Statistic to get.  Either "cases", "deaths" or "rates"
     limit: int
         Number of raw data to show
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -77,6 +77,6 @@ alt.covid.stat(
         Format to export data
     plot : bool
         Flag to plot data
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/alt/oss/history/_index.rst b/website/content/SDK/alt/oss/history/_index.rst
@@ -29,7 +29,7 @@ alt.oss.history(
 
     repo : str
             Repo to search for Format: org/repo, e.g., openbb-finance/openbbterminal
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -68,6 +68,6 @@ alt.oss.history(
             Export dataframe data to csv,json,xlsx file
     external_axes : Optional[List[plt.Axes]], optional
             External axes (1 axis is expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/alt/oss/ross/_index.rst b/website/content/SDK/alt/oss/ross/_index.rst
@@ -72,6 +72,6 @@ alt.oss.ross(
         Export dataframe data to csv,json,xlsx file
     external_axes : Optional[List[plt.Axes]], optional
         External axes (1 axis is expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/alt/oss/summary/_index.rst b/website/content/SDK/alt/oss/summary/_index.rst
@@ -29,7 +29,7 @@ alt.oss.summary(
 
     repo : str
             Repo to search for Format: org/repo, e.g., openbb-finance/openbbterminal
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -65,6 +65,6 @@ alt.oss.summary(
             Repository to display summary. Format: org/repo, e.g., openbb-finance/openbbterminal
     export : str
         Export dataframe data to csv,json,xlsx file
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/alt/oss/top/_index.rst b/website/content/SDK/alt/oss/top/_index.rst
@@ -35,7 +35,7 @@ alt.oss.top(
             Check for repo categories. If more than one separate with a comma: e.g., finance,investment. Default: None
     limit : int
             Number of repos to search for
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -80,6 +80,6 @@ alt.oss.top(
         Export dataframe data to csv,json,xlsx file
     external_axes : Optional[List[plt.Axes]], optional
         External axes (1 axis is expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/bw/_index.rst b/website/content/SDK/common/qa/bw/_index.rst
@@ -41,7 +41,7 @@ common.qa.bw(
         Flag to indicate yearly accumulation
     external_axes : Optional[List[plt.Axes]], optional
         External axes (1 axis is expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -82,6 +82,6 @@ common.qa.bw(
         Flag to indicate yearly accumulation
     external_axes : Optional[List[plt.Axes]], optional
         External axes (1 axis is expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/es/_index.rst b/website/content/SDK/common/qa/es/_index.rst
@@ -41,7 +41,7 @@ common.qa.es(
         VaR percentile
     portfolio: bool
         If the data is a portfolio
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -90,6 +90,6 @@ common.qa.es(
         es percentile
     portfolio: bool
         If the data is a portfolio
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/kurtosis/_index.rst b/website/content/SDK/common/qa/kurtosis/_index.rst
@@ -32,7 +32,7 @@ common.qa.kurtosis(
         Dataframe of targeted data
     window: int
         Length of window
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -81,6 +81,6 @@ common.qa.kurtosis(
         Format to export data
     external_axes: Optional[List[plt.Axes]], optional
         External axes (2 axes are expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/normality/_index.rst b/website/content/SDK/common/qa/normality/_index.rst
@@ -31,7 +31,7 @@ common.qa.normality(
 
     data : pd.DataFrame
         Dataframe of targeted data
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -71,6 +71,6 @@ common.qa.normality(
         Column in data to look at
     export : str
         Format to export data
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/omega/_index.rst b/website/content/SDK/common/qa/omega/_index.rst
@@ -35,7 +35,7 @@ common.qa.omega(
         annualized target return threshold start of plotted threshold range
     threshold_end: float
         annualized target return threshold end of plotted threshold range
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -70,6 +70,6 @@ common.qa.omega(
         annualized target return threshold start of plotted threshold range
     threshold_end: float
         annualized target return threshold end of plotted threshold range
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/quantile/_index.rst b/website/content/SDK/common/qa/quantile/_index.rst
@@ -35,7 +35,7 @@ common.qa.quantile(
         Length of window
     quantile_pct: float
         Quantile to display
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -89,6 +89,6 @@ common.qa.quantile(
         Format to export data
     external_axes: Optional[List[plt.Axes]], optional
         External axes (1 axis is expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/rolling/_index.rst b/website/content/SDK/common/qa/rolling/_index.rst
@@ -32,7 +32,7 @@ common.qa.rolling(
         Dataframe of target data
     window: int
         Length of rolling window
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -83,6 +83,6 @@ common.qa.rolling(
         Format to export data
     external_axes: Optional[List[plt.Axes]], optional
         External axes (2 axes are expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/sharpe/_index.rst b/website/content/SDK/common/qa/sharpe/_index.rst
@@ -35,7 +35,7 @@ common.qa.sharpe(
         risk free rate
     window: float
         length of the rolling window
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -75,6 +75,6 @@ common.qa.sharpe(
         risk free rate
     window: float
         length of the rolling window
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/skew/_index.rst b/website/content/SDK/common/qa/skew/_index.rst
@@ -32,7 +32,7 @@ common.qa.skew(
         Dataframe of targeted data
     window : int
         Length of window
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -81,6 +81,6 @@ common.qa.skew(
         Format to export data
     external_axes: Optional[List[plt.Axes]], optional
         External axes (2 axes are expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/sortino/_index.rst b/website/content/SDK/common/qa/sortino/_index.rst
@@ -38,7 +38,7 @@ common.qa.sortino(
         length of the rolling window
     adjusted: bool
         adjust the sortino ratio
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -81,6 +81,6 @@ common.qa.sortino(
         length of the rolling window
     adjusted: bool
         adjust the sortino ratio
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/spread/_index.rst b/website/content/SDK/common/qa/spread/_index.rst
@@ -32,7 +32,7 @@ common.qa.spread(
         DataFrame of targeted data
     window: int
         Length of window
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -85,6 +85,6 @@ common.qa.spread(
         Format to export data
     external_axes: Optional[List[plt.Axes]], optional
         External axes (3 axes are expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/summary/_index.rst b/website/content/SDK/common/qa/summary/_index.rst
@@ -29,7 +29,7 @@ common.qa.summary(
 
     data : pd.DataFrame
         Dataframe to get summary statistics for
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -66,6 +66,6 @@ common.qa.summary(
         DataFrame to get statistics of
     export : str
         Format to export data
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/unitroot/_index.rst b/website/content/SDK/common/qa/unitroot/_index.rst
@@ -35,7 +35,7 @@ common.qa.unitroot(
         Type of regression of ADF test. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order
     kpss_reg : str
         Type of regression for KPSS test.  Can be ‘c’,’ct'
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -81,6 +81,6 @@ common.qa.unitroot(
         Type of regression for KPSS test. Can be ‘c’,’ct'
     export : str
         Format for exporting data
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/qa/var/_index.rst b/website/content/SDK/common/qa/var/_index.rst
@@ -44,7 +44,7 @@ common.qa.var(
         VaR percentile
     portfolio: bool
         If the data is a portfolio
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -99,6 +99,6 @@ common.qa.var(
         Number of rows you want to use VaR over
     portfolio: bool
         If the data is a portfolio
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/ta/ad/_index.rst b/website/content/SDK/common/ta/ad/_index.rst
@@ -32,7 +32,7 @@ common.ta.ad(
         Dataframe of prices with OHLC and Volume
     use_open : bool
         Whether to use open prices
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -78,6 +78,6 @@ common.ta.ad(
         Format to export data as
     external_axes : Optional[List[plt.Axes]], optional
         External axes (3 axes are expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/ta/adosc/_index.rst b/website/content/SDK/common/ta/adosc/_index.rst
@@ -38,7 +38,7 @@ common.ta.adosc(
         Fast value
     slow: int
         Slow value
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -90,6 +90,6 @@ common.ta.adosc(
         Format to export data
     external_axes : Optional[List[plt.Axes]], optional
         External axes (3 axes are expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
diff --git a/website/content/SDK/common/ta/adx/_index.rst b/website/content/SDK/common/ta/adx/_index.rst
@@ -38,7 +38,7 @@ common.ta.adx(
         Scalar variable
     drift: int
         Drift variable
-    chart: *bool*
+    chart: bool
        Flag to display chart
 
 
@@ -90,6 +90,6 @@ common.ta.adx(
         Format to export data
     external_axes : Optional[List[plt.Axes]], optional
         External axes (2 axes are expected in the list), by default None
-    chart: *bool*
+    chart: bool
        Flag to display chart