names_extra.py updated to support sphinx docs

simfin/names_extra.py

@@ -14,153 +14,153 @@
 ##########################################################################
 # Per-Share Numbers.
 
-# Sales / Number of Shares.
+#: Sales / Number of Shares.
 SPS = SALES_PER_SHARE = 'Sales Per Share'
 
-# Net Income / Number of Shares.
+#: Net Income / Number of Shares.
 EPS = EARNINGS_PER_SHARE = 'Earnings Per Share'
 
-# Total Equity / Number of Shares.
+#: Total Equity / Number of Shares.
 EQ_PS = EQUITY_PER_SHARE = BV_PS = BOOK_VALUE_PER_SHARE = 'Equity Per Share'
 
-# Free Cash Flow / Number of Shares.
+#: Free Cash Flow / Number of Shares.
 FCF_PS = 'Free Cash Flow Per Share'
 
 ##########################################################################
 # Valuation Signals.
 
-# Price / Earnings Ratio.
+#: Price / Earnings Ratio.
 P_E = PE = 'P/E'
 
-# Price / Sales Ratio.
+#: Price / Sales Ratio.
 P_SALES = PSALES = 'P/Sales'
 
-# Price / Free Cash Flow.
+#: Price / Free Cash Flow.
 P_FCF = PFCF = 'P/FCF'
 
-# Price / Book-Value (aka. Equity).
+#: Price / Book-Value (aka. Equity).
 P_BOOK = PBOOK = 'P/Book'
 
-# Price / Net Current Asset Value (NCAV).
-# Where NCAV = Current Assets - Total Liabilities.
-# This formula is attributed to Ben Graham (Warren Buffett's teacher).
-# It compares the share-price relative to an estimated liquidation value,
-# which may be overestimated because the Current Assets may not be sold at
-# their actual book-value. The P_NETNET ratio is a more conservative estimate.
+#: Price / Net Current Asset Value (NCAV).
+#: Where NCAV = Current Assets - Total Liabilities.
+#: This formula is attributed to Ben Graham (Warren Buffett's teacher).
+#: It compares the share-price relative to an estimated liquidation value,
+#: which may be overestimated because the Current Assets may not be sold at
+#: their actual book-value. The P_NETNET ratio is a more conservative estimate.
 P_NCAV = PNCAV = 'P/NCAV'
 
-# Net Current Asset Value (see P_NCAV for more explanation).
+#: Net Current Asset Value (see P_NCAV for more explanation).
 NCAV = 'Net Current Asset Value (NCAV)'
 
-# Price / NetNet Working Capital (NetNet aka. NNWC).
-# Where NetNet = Cash & Equiv. + 0.75 * Receivables
-#              + 0.5 * Inventory - Total Liabilities.
-# This formula is attributed to Ben Graham (Warren Buffett's teacher).
-# It compares the share-price relative to an estimated liquidation value.
-# This is more conservative than P_NCAV because Receivables and Inventories
-# are not fully counted in the estimate of the liquidation value.
+#: Price / NetNet Working Capital (NetNet aka. NNWC).
+#: Where NetNet = Cash & Equiv. + 0.75 * Receivables
+#:              + 0.5 * Inventory - Total Liabilities.
+#: This formula is attributed to Ben Graham (Warren Buffett's teacher).
+#: It compares the share-price relative to an estimated liquidation value.
+#: This is more conservative than P_NCAV because Receivables and Inventories
+#: are not fully counted in the estimate of the liquidation value.
 P_NETNET = PNETNET = P_NNWC = PNNWC = 'P/NetNet'
 
-# NetNet Working Capital (see P_NETNET for more explanation).
+#: NetNet Working Capital (see P_NETNET for more explanation).
 NETNET = 'NetNet Working Capital'
 
-# Earnings / Price.
+#: Earnings / Price.
 EARNINGS_YIELD = 'Earnings Yield'
 
-# FCF / Price.
+#: FCF / Price.
 FCF_YIELD = 'FCF Yield'
 
-# Dividend TTM / Share-Price.
+#: Dividend TTM / Share-Price.
 DIV_YIELD = DIVIDEND_YIELD = 'Dividend Yield'
 
-# Market Capitalization = Shares Outstanding * Share-Price.
+#: Market Capitalization = Shares Outstanding * Share-Price.
 MCAP = MARKET_CAP = 'Market-Cap'
 
 ##########################################################################
 # Financial Signals.
 
-# Free Cash Flow.
+#: Free Cash Flow.
 FCF = 'Free Cash Flow'
 
-# Earnings Before Interest, Taxes, Depreciation & Amortization.
+#: Earnings Before Interest, Taxes, Depreciation & Amortization.
 EBITDA = 'EBITDA'
 
-# Net Income / Revenue.
+#: Net Income / Revenue.
 NET_PROFIT_MARGIN = 'Net Profit Margin'
 
-# Gross Profit / Revenue.
+#: Gross Profit / Revenue.
 GROSS_PROFIT_MARGIN = 'Gross Profit Margin'
 
-# Current Assets / Current Liabilities.
+#: Current Assets / Current Liabilities.
 CURRENT_RATIO = 'Current Ratio'
 
-# (Short-Term Debt + Long-Term Debt) / Total Assets
+#: (Short-Term Debt + Long-Term Debt) / Total Assets
 DEBT_RATIO = 'Debt Ratio'
 
-# Net Income / Total Assets.
+#: Net Income / Total Assets.
 ROA = 'Return on Assets'
 
-# Net Income / Shareholder Equity.
+#: Net Income / Shareholder Equity.
 ROE = 'Return on Equity'
 
-# Revenue / Total Assets.
+#: Revenue / Total Assets.
 ASSET_TURNOVER = 'Asset Turnover'
 
 ##########################################################################
 # Growth Signals.
 
-# Sales or Revenue Growth.
+#: Sales or Revenue Growth.
 SALES_GROWTH = 'Sales Growth'
 SALES_GROWTH_QOQ = 'Sales Growth QOQ'
 SALES_GROWTH_YOY = 'Sales Growth YOY'
 
-# Earnings or Net Income Growth.
+#: Earnings or Net Income Growth.
 EARNINGS_GROWTH = 'Earnings Growth'
 EARNINGS_GROWTH_QOQ = 'Earnings Growth QOQ'
 EARNINGS_GROWTH_YOY = 'Earnings Growth YOY'
 
-# Free Cash Flow (FCF) Growth.
+#: Free Cash Flow (FCF) Growth.
 FCF_GROWTH = 'FCF Growth'
 FCF_GROWTH_QOQ = 'FCF Growth QOQ'
 FCF_GROWTH_YOY = 'FCF Growth YOY'
 
 ##########################################################################
 # Price Signals.
 
-# Moving Average.
+#: Moving Average.
 MAVG_20 = 'MAVG 20'
 MAVG_200 = 'MAVG 200'
 
-# Exponential Moving Average.
+#: Exponential Moving Average.
 EMA = 'EMA'
 
-# Moving Average Convergence Divergence.
+#: Moving Average Convergence Divergence.
 MACD = 'MACD'
 
-# MACD with extra smoothing by Exp. Moving Average.
+#: MACD with extra smoothing by Exp. Moving Average.
 MACD_EMA = 'MACD-EMA'
 
-# Buy signal (typically a boolean value).
+#: Buy signal (typically a boolean value).
 BUY = 'Buy'
 
-# Sell signal (typically a boolean value).
+#: Sell signal (typically a boolean value).
 SELL = 'Sell'
 
-# Hold signal (typically a boolean value).
+#: Hold signal (typically a boolean value).
 HOLD = 'Hold'
 
 ##########################################################################
 # Volume Signals.
 
-# Daily trading-volume relative to its moving average.
+#: Daily trading-volume relative to its moving average.
 REL_VOL = 'Relative Volume'
 
-# Market-Capitalization of the daily trading-volume.
-# Defined as: Volume x Share-Price.
+#: Market-Capitalization of the daily trading-volume.
+#: Defined as: Volume x Share-Price.
 VOL_MCAP = VOLUME_MCAP = 'Volume Market-Cap'
 
-# Daily trading-volume relative to the number of shares outstanding.
-# Defined as: Volume / Shares Outstanding
+#: Daily trading-volume relative to the number of shares outstanding.
+#: Defined as: Volume / Shares Outstanding
 VOL_TURN = VOLUME_TURNOVER = 'Volume Turnover'
 
 ##########################################################################