Fix mypy hook and Resolve documentation errors (#1008)

* Make mypy pre-commit check non-strict

* Fix mypy pre-commit hook

* Update docstrings to be compliant with sphinx-readthedocs commonmark

* Change report path to be relative to the module and not the terminal.py

* Update class library documentation
This commit is contained in:
Theodore Aptekarev
2021-12-02 02:19:50 +03:00
committed by GitHub
parent 233d9411f3
commit 79bacf3f51
20 changed files with 398 additions and 276 deletions

View File

@@ -44,6 +44,22 @@ gamestonk\_terminal.cryptocurrency.defi.defirate\_view module
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.defi.graph\_model module
-----------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.defi.graph_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.defi.graph\_view module
----------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.defi.graph_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.defi.llama\_model module
-----------------------------------------------------------

View File

@@ -20,22 +20,6 @@ gamestonk\_terminal.cryptocurrency.due\_diligence.binance\_view module
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.due\_diligence.bybt\_model module
--------------------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.bybt_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.due\_diligence.bybt\_view module
-------------------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.bybt_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.due\_diligence.coinbase\_model module
------------------------------------------------------------------------
@@ -52,6 +36,22 @@ gamestonk\_terminal.cryptocurrency.due\_diligence.coinbase\_view module
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.due\_diligence.coinglass\_model module
-------------------------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.coinglass_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.due\_diligence.coinglass\_view module
------------------------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.coinglass_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.due\_diligence.coinpaprika\_model module
---------------------------------------------------------------------------
@@ -84,6 +84,22 @@ gamestonk\_terminal.cryptocurrency.due\_diligence.finbrain\_crypto\_view module
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.due\_diligence.glassnode\_model module
-------------------------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.glassnode_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.due\_diligence.glassnode\_view module
------------------------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.glassnode_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.due\_diligence.pycoingecko\_model module
---------------------------------------------------------------------------

View File

@@ -36,22 +36,6 @@ gamestonk\_terminal.cryptocurrency.onchain.ethplorer\_view module
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.onchain.glassnode\_model module
------------------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.onchain.glassnode_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.onchain.glassnode\_view module
-----------------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.onchain.glassnode_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.onchain.onchain\_controller module
---------------------------------------------------------------------

View File

@@ -36,6 +36,22 @@ gamestonk\_terminal.cryptocurrency.overview.coinpaprika\_view module
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.overview.cryptopanic\_model module
---------------------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.overview.cryptopanic_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.overview.cryptopanic\_view module
--------------------------------------------------------------------
.. automodule:: gamestonk_terminal.cryptocurrency.overview.cryptopanic_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.cryptocurrency.overview.overview\_controller module
-----------------------------------------------------------------------

View File

@@ -100,6 +100,22 @@ gamestonk\_terminal.economy.fred\_view module
:undoc-members:
:show-inheritance:
gamestonk\_terminal.economy.nasdaq\_model module
------------------------------------------------
.. automodule:: gamestonk_terminal.economy.nasdaq_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.economy.nasdaq\_view module
-----------------------------------------------
.. automodule:: gamestonk_terminal.economy.nasdaq_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.economy.wsj\_model module
---------------------------------------------

View File

@@ -1,165 +0,0 @@
gamestonk\_terminal.options package
===================================
Submodules
----------
gamestonk\_terminal.options.alphaquery\_model module
----------------------------------------------------
.. automodule:: gamestonk_terminal.options.alphaquery_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.alphaquery\_view module
---------------------------------------------------
.. automodule:: gamestonk_terminal.options.alphaquery_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.barchart\_model module
--------------------------------------------------
.. automodule:: gamestonk_terminal.options.barchart_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.barchart\_view module
-------------------------------------------------
.. automodule:: gamestonk_terminal.options.barchart_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.calculator\_model module
----------------------------------------------------
.. automodule:: gamestonk_terminal.options.calculator_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.calculator\_view module
---------------------------------------------------
.. automodule:: gamestonk_terminal.options.calculator_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.chartexchange\_model module
-------------------------------------------------------
.. automodule:: gamestonk_terminal.options.chartexchange_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.chartexchange\_view module
------------------------------------------------------
.. automodule:: gamestonk_terminal.options.chartexchange_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.fdscanner\_model module
---------------------------------------------------
.. automodule:: gamestonk_terminal.options.fdscanner_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.fdscanner\_view module
--------------------------------------------------
.. automodule:: gamestonk_terminal.options.fdscanner_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.op\_helpers module
----------------------------------------------
.. automodule:: gamestonk_terminal.options.op_helpers
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.options\_controller module
------------------------------------------------------
.. automodule:: gamestonk_terminal.options.options_controller
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.payoff\_controller module
-----------------------------------------------------
.. automodule:: gamestonk_terminal.options.payoff_controller
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.syncretism\_model module
----------------------------------------------------
.. automodule:: gamestonk_terminal.options.syncretism_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.syncretism\_view module
---------------------------------------------------
.. automodule:: gamestonk_terminal.options.syncretism_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.tradier\_model module
-------------------------------------------------
.. automodule:: gamestonk_terminal.options.tradier_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.tradier\_view module
------------------------------------------------
.. automodule:: gamestonk_terminal.options.tradier_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.yfinance\_model module
--------------------------------------------------
.. automodule:: gamestonk_terminal.options.yfinance_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.options.yfinance\_view module
-------------------------------------------------
.. automodule:: gamestonk_terminal.options.yfinance_view
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: gamestonk_terminal.options
:members:
:undoc-members:
:show-inheritance:

View File

@@ -12,7 +12,6 @@ Subpackages
gamestonk_terminal.economy
gamestonk_terminal.etf
gamestonk_terminal.forex
gamestonk_terminal.options
gamestonk_terminal.portfolio
gamestonk_terminal.reports
gamestonk_terminal.resources

View File

@@ -28,6 +28,22 @@ gamestonk\_terminal.stocks.dark\_pool\_shorts.finra\_view module
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.dark\_pool\_shorts.nyse\_model module
----------------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.nyse_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.dark\_pool\_shorts.nyse\_view module
---------------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.nyse_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.dark\_pool\_shorts.quandl\_model module
------------------------------------------------------------------

View File

@@ -100,6 +100,22 @@ gamestonk\_terminal.stocks.discovery.marketbeat\_view module
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.discovery.nasdaq\_model module
---------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.discovery.nasdaq_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.discovery.nasdaq\_view module
--------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.discovery.nasdaq_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.discovery.seeking\_alpha\_model module
-----------------------------------------------------------------

View File

@@ -0,0 +1,173 @@
gamestonk\_terminal.stocks.options package
==========================================
Submodules
----------
gamestonk\_terminal.stocks.options.alphaquery\_model module
-----------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.alphaquery_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.alphaquery\_view module
----------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.alphaquery_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.barchart\_model module
---------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.barchart_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.barchart\_view module
--------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.barchart_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.calculator\_model module
-----------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.calculator_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.calculator\_view module
----------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.calculator_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.chartexchange\_model module
--------------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.chartexchange_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.chartexchange\_view module
-------------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.chartexchange_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.fdscanner\_model module
----------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.fdscanner_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.fdscanner\_view module
---------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.fdscanner_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.op\_helpers module
-----------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.op_helpers
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.options\_controller module
-------------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.options_controller
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.payoff\_controller module
------------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.payoff_controller
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.pricing\_controller module
-------------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.pricing_controller
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.syncretism\_model module
-----------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.syncretism_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.syncretism\_view module
----------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.syncretism_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.tradier\_model module
--------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.tradier_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.tradier\_view module
-------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.tradier_view
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.yfinance\_model module
---------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.yfinance_model
:members:
:undoc-members:
:show-inheritance:
gamestonk\_terminal.stocks.options.yfinance\_view module
--------------------------------------------------------
.. automodule:: gamestonk_terminal.stocks.options.yfinance_view
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: gamestonk_terminal.stocks.options
:members:
:undoc-members:
:show-inheritance:

View File

@@ -16,6 +16,7 @@ Subpackages
gamestonk_terminal.stocks.fundamental_analysis
gamestonk_terminal.stocks.government
gamestonk_terminal.stocks.insider
gamestonk_terminal.stocks.options
gamestonk_terminal.stocks.prediction_techniques
gamestonk_terminal.stocks.quantitative_analysis
gamestonk_terminal.stocks.research