docs first necessatiy implemented

97gamjak · Feb 26, 2024 · f86e427 · f86e427
1 parent e7a2f44
commit f86e427
Show file tree

Hide file tree

Showing 3 changed files with 183 additions and 182 deletions.
diff --git a/docs/source/financialStatments/cashflow.rst b/docs/source/financialStatments/cashflow.rst
@@ -4,22 +4,47 @@ Cash Flow
 Basic KPIs
 ==========
 
-* Operating Cash Flow
-* Depreciation
-* Amortization
-* Capital Expenditure
+.. list-table::
+    :header-rows: 1
+    :class: tight-table
+
+    * - KPI
+      - ID
+      - Description
+      - IBKR ID
+    * - Operating Cash Flow
+      - OpCF
+      - The amount of cash generated by the regular operating activities of a business in a specific time period.
+      - OTLO
+    * - Depreciation
+      - Dep
+      - The decrease in value of an asset over time.
+      - SDED
+    * - Amortization
+      - Amort
+      - The process of spreading the cost of an intangible asset over its useful life.
+      - SAMT
+    * - Capital Expenditure
+      - CapEx
+      - The funds used by a company to acquire or upgrade physical assets such as property, industrial buildings or equipment.
+      - SCEX
 
 Derived KPIs
 ============
-.. admonition::
-    Free Cash Flow
-
-    .. math::
-
-        Free Cash Flow = Operation Cash Flow - Capital Expanditures
 
-.. admonition::
-    Depreciation & Amortization
+.. list-table::
+    :header-rows: 1
+    :class: tight-table
 
-    .. math::
-        Depreciation & Amortization = Depreciation + Amortization
+    * - KPI
+      - ID
+      - Description
+      - Formula
+    * - Free Cash Flow
+      - FreeCF
+      - The amount of cash a company has left over after it has paid all of its expenses, including investments.
+      - :math:`FreeCF = OpCF - CapEx`
+    * - Depreciation \& Amortization
+      - D&A
+      - The total amount of depreciation and amortization.
+      - :math:`D\&A = Dep + Amort`
diff --git a/docs/source/financialStatments/general.rst b/docs/source/financialStatments/general.rst
@@ -1,112 +1,91 @@
+.. _general:
+
+*******
 General
 *******
-Derived KPIs
-============
 
-.. admonition::
-    Growth Rate
+If any of the following derived KPIs contain a growth rate, it is assumed that the growth rate is not fixed to a certain time period. Therefore, the growth rate is always noramlized to a yearly growth rate. This can be achieved by the following formula:
 
-    .. math::
+.. math::
         Growth(KPI, n_{\text{years}}) = \frac{KPI_{\text{new}}}{KPI_{\text{old}}}^{1/n_{\text{years}}} - 1
 
-.. admonition::
-    Earnings Per Share
-
-    .. math::
-        EPS = \frac{Net Income}{Total Outstanding Shares Common Stock}
-
-.. admonition::
-   Revenue Per Share
-
-   .. math::
-        RPS = \frac{Revenue}{Total Outstanding Shares Common Stock}
-
-.. admonition::
-   Operating Cash Flow Per Share
-
-   .. math::
-        OCPS = \frac{Operatong Cash Flow}{Total Outstanding Shares Common Stock}
-
-.. admonition::
-   Free Cash Flow Per Share
-
-   .. math::
-        FCPS = \frac{Free Cash Flow}{Total Outstanding Shares Common Stock}
-
-.. admonition::
-    EBITDA
-
-    .. math::
-        EBITDA = EBIT + DEPRECIATION \& AMORTIZATION
-
-.. admonition::
-    EBIDTA Margin
-
-    .. math::
-        EBIDTA MARGIN = \frac{EBITDA}{REVENUE}
-
-.. admonition::
-    Return On Assets
-
-    .. math::
-        Return On Assets = \frac{Net Income}{Total Assets}
-
-.. admonition::
-    Price/Earnings
-
-    .. math::
-        P/E = \frac{Price}{EPS}
-
-.. admonition::
-    Price/Revenue
-
-    .. math::
-        P/R = \frac{Price}{RPS}
-
-.. admonition::
-    Price/Operating Cash Flow
-
-    .. math::
-        P/OC = \frac{Price}{OCPS}
-
-.. admonition::
-    Price/Free Cash Flow
-
-    .. math::
-        P/FC = \frac{Price}{FCPS}
-
-.. admonition::
-   Price/Book Value
-
-    .. math::
-          P/B = \frac{Price}{BPS}
-
-.. admonition::
-    Price To Earnings Growth
-
-    .. math::
-        PEG = \frac{P/E}{Growth(EPS, n)}
-
-.. admonition::
-    Price To Revenue Growth
-
-    .. math::
-        PRG = \frac{P/R}{Growth(RPS, n)}
-
-.. admonition::
-    Price To Operating Cash Flow Growth
-
-    .. math::
-        POCG = \frac{P/OC}{Growth(OCPS, n)}
-
-.. admonition::
-    Price To Free Cash Flow Growth
-
-    .. math::
-        PFCG = \frac{P/FC}{Growth(FCPS, n)}
-
-.. admonition::
-    Price To Book Value Growth
+============
+Derived KPIs
+============
 
-    .. math::
-        PBG = \frac{P/B}{Growth(BPS, n)}
+.. list-table::
+    :header-rows: 1
+    :class: tight-table
+
+    * - KPI
+      - ID
+      - Description
+      - Formula
+    * - Earnings Per Share
+      - EPS
+      - Net Income divided by Total Outstanding Shares Common Stock
+      - :math:`\frac{NetInc}{TotOutShares}`
+    * - Revenue Per Share
+      - RPS
+      - Revenue divided by Total Outstanding Shares Common Stock
+      - :math:`\frac{Rev}{TotOutShares}`
+    * - Operating Cash Flow Per Share
+      - OpCFPS
+      - Operating Cash Flow divided by Total Outstanding Shares Common Stock
+      - :math:`\frac{OpCF}{TotOutShares}`
+    * - Free Cash Flow Per Share
+      - FreeCFPS
+      - Free Cash Flow divided by Total Outstanding Shares Common Stock
+      - :math:`\frac{FreeCF}{TotOutShares}`
+    * - EBITDA
+      - EBITDA
+      - EBIT + Depreciation & Amortization
+      - :math:`EBIT + D\&A`
+    * - EBITDA Margin
+      - EBITDAMargin
+      - EBITDA divided by Revenue
+      - :math:`\frac{EBITDA}{Rev}`
+    * - Return On Assets
+      - RetOnAss
+      - Return on Assets is a measure of how effectively a company uses its assets to generate earnings
+      - :math:`\frac{NetInc}{TotAss}`
+    * - Price/Earnings
+      - P/E
+      - Price divided by Earnings Per Share
+      - :math:`\frac{Price}{EPS}`
+    * - Price/Revenue
+      - P/R
+      - Price divided by Revenue Per Share
+      - :math:`\frac{Price}{RPS}`
+    * - Price/Operating Cash Flow
+      - P/OpCF
+      - Price divided by Operating Cash Flow Per Share
+      - :math:`\frac{Price}{OpCFPS}`
+    * - Price/Free Cash Flow
+      - P/FreeCF
+      - Price divided by Free Cash Flow Per Share
+      - :math:`\frac{Price}{FreeCFPS}`
+    * - Price/Book Value
+      - P/B
+      - Price divided by Book Value Per Share
+      - :math:`\frac{Price}{BPS}`
+    * - Price To Earnings Growth
+      - PEG
+      - Price To Earnings divided by Growth(EPS, n)
+      - :math:`\frac{P/E}{Growth(EPS)}`
+    * - Price To Revenue Growth
+      - PRG
+      - Price To Revenue divided by Growth(RPS, n)
+      - :math:`\frac{P/R}{Growth(RPS)}`
+    * - Price To Operating Cash Flow Growth
+      - POCG
+      - Price To Operating Cash Flow divided by Growth(OpCFPS, n)
+      - :math:`\frac{P/OpCF}{Growth(OpCFPS)}`
+    * - Price To Free Cash Flow Growth
+      - PFCG
+      - Price To Free Cash Flow divided by Growth(FreeCFPS, n)
+      - :math:`\frac{P/FreeCF}{Growth(FreeCFPS)}`
+    * - Price To Book Value Growth
+      - PBG
+      - Price To Book Value divided by Growth(BPS, n)
+      - :math:`\frac{P/B}{Growth(BPS)}`
diff --git a/docs/source/financialStatments/incomeStatement.rst b/docs/source/financialStatments/incomeStatement.rst
@@ -1,73 +1,70 @@
 Income Statement
 ****************
 
-KPIs
-====
+Basic KPIs
+==========
 
 .. list-table::
-   :header-rows: 1
+    :header-rows: 1
+    :class: tight-table
+
+    * - KPI
+      - ID
+      - Description
+      - IBKR ID
+    * - Revenue (Excluding Financial Services)
+      - REV
+      - Revenue is the total amount of income generated by the sale of goods or services related to the company's primary operations. It is also known as sales or turnover.
+      - RTLR
+    * - Gross Profit
+      - GRP
+      - Gross profit is the difference between revenue and the cost of making a product or providing a service, before deducting overheads, payroll, taxation, and interest payments.
+      - SGRP
+    * - Selling, General & Administrative Expenses
+      - SellGenAdmExp
+      - Selling, general and administrative expenses (SG&A) are a company's total direct and indirect selling expenses and all general and administrative expenses.
+      - SSGA
+    * - Total Operating Expenses
+      - TotOpExp
+      - Total operating expenses are the sum of all direct and indirect selling expenses and all general and administrative expenses.
+      - ETOE
+    * - Net Income
+      - NetInc
+      - Net income is the total amount of income generated by the sale of goods or services related to the company's primary operations. It is also known as sales or turnover.
+      - NINC
+    * - Interest Income
+      - IntInc
+      - Interest income is the amount of interest that has been earned during a specific time period.
+      - SIIB
+    * - Non-Interest Income
+      - NonIntInc
+      - Non-interest income is the portion of an institution's income that is derived from non-interest sources.
+      - SNII
 
-   * - KPI
-     - Description
-     - ID
-     - Derived from
-   * - REV
-     - Revenue (Excluding Financial Services)
-     - RTLR
-     -
-   * - REV (Financial Services)
-     - Revenue (Financial Services)
-     - RTLR
-     - II, NII, 
-   * - GRP
-     - Gross Profit
-     - SGRP
-     -
-   * - SGA
-     - Selling, General & Administrative Expenses
-     - SSGA
-     -
-   * - TOE
-     - Total Operating Expenses
-     - ETOE
-     -
-   * - NINC
-     - Net Income
-     - NINC
-     -
-   * - NII
-     - Non-Interest Income (Financial Services)
-     - SNII
-     -
-   * - II
-     - Interest Income (Financial Services)
-     - SIIB
-     -
 Derived KPIs
 ============
 
-.. admonition::
-    Revenue (Financial Services)
-
-    .. math::
-        REV = NII + II
-
-.. admonition::
-    EBIT (Excluding Financial Services)
-
-    .. math::
-        EBIT = REV - TOE
-
-.. admonition::
-    EBIT Margin (Excluding Financial Services)
-
-    .. math::
-        EBIT\text{ }Margin = \frac{EBIT}{REV}
-
-.. admonition::
-    Netto Margin
+.. list-table::
+    :header-rows: 1
+    :class: tight-table
 
-    .. math::
-        Netto\text{ }Margin = \frac{NINC}{REV}
-
-
+    * - KPI
+      - ID
+      - Description
+      - Formula
+    * - Revenue (Financial Services)
+      - Rev
+      - Revenue (Financial Services) is the total amount of income generated by the sale of goods or services related to the company's primary operations. It is also known as sales or turnover.
+      - :math:`IntInc + NonIntInc`
+    * - EBIT (Excluding Financial Services)
+      - EBIT
+      - EBIT (Excluding Financial Services) is the difference between revenue and the total operating expenses.
+      - :math:`Rev - TotOpExp`
+    * - EBIT Margin (Excluding Financial Services)
+      - EBITMargin
+      - EBIT Margin (Excluding Financial Services) is the ratio of EBIT (Excluding Financial Services) to Revenue (Excluding Financial Services).
+      - :math:`\frac{EBIT}{Rev}` 
+    * - Netto Margin
+      - NettoMargin
+      - Netto Margin is the ratio of Net Income to Revenue.
+      - :math:`\frac{NetInc}{Rev}`