From 2ea3006c07e37fc684fed19429b42e60ea2ac658 Mon Sep 17 00:00:00 2001 From: Theodore Aptekarev Date: Tue, 2 Nov 2021 00:11:29 +0300 Subject: [PATCH] Update readthedocs creation pipeline #859 (#895) * Add built documentation to gitignore * Add documentation creation readme and requirements * Change manually generated code docs to automatic * Move myst_parser documentation requirement to pyproject.toml * Update poetry and requirements files for the readthedocs build to work * Add prediction extras to requirements-full --- .gitignore | 3 + docs/README.md | 15 + docs/code.rst | 316 ------------------ ...k_terminal.common.behavioural_analysis.rst | 133 ++++++++ ..._terminal.common.prediction_techniques.rst | 117 +++++++ ..._terminal.common.quantitative_analysis.rst | 45 +++ docs/code/gamestonk_terminal.common.rst | 32 ++ ...onk_terminal.common.technical_analysis.rst | 117 +++++++ ...gamestonk_terminal.cryptocurrency.defi.rst | 85 +++++ ...tonk_terminal.cryptocurrency.discovery.rst | 69 ++++ ..._terminal.cryptocurrency.due_diligence.rst | 109 ++++++ ...estonk_terminal.cryptocurrency.onchain.rst | 85 +++++ ...stonk_terminal.cryptocurrency.overview.rst | 69 ++++ .../gamestonk_terminal.cryptocurrency.rst | 74 ++++ ...inal.cryptocurrency.technical_analysis.rst | 21 ++ docs/code/gamestonk_terminal.economy.rst | 125 +++++++ docs/code/gamestonk_terminal.etf.rst | 77 +++++ ...nk_terminal.forex.behavioural_analysis.rst | 21 ++ ...rminal.forex.exploratory_data_analysis.rst | 21 ++ docs/code/gamestonk_terminal.forex.rst | 38 +++ docs/code/gamestonk_terminal.options.rst | 165 +++++++++ ...nk_terminal.portfolio.brokers.coinbase.rst | 37 ++ ...tonk_terminal.portfolio.brokers.degiro.rst | 37 ++ .../gamestonk_terminal.portfolio.brokers.rst | 38 +++ ..._terminal.portfolio.portfolio_analysis.rst | 37 ++ ...minal.portfolio.portfolio_optimization.rst | 53 +++ docs/code/gamestonk_terminal.portfolio.rst | 71 ++++ docs/code/gamestonk_terminal.reports.rst | 21 ++ docs/code/gamestonk_terminal.resources.rst | 21 ++ docs/code/gamestonk_terminal.rst | 102 ++++++ .../gamestonk_terminal.stocks.backtesting.rst | 37 ++ ...k_terminal.stocks.behavioural_analysis.rst | 21 ++ ...nk_terminal.stocks.comparison_analysis.rst | 101 ++++++ ...stonk_terminal.stocks.dark_pool_shorts.rst | 117 +++++++ .../gamestonk_terminal.stocks.discovery.rst | 157 +++++++++ ...amestonk_terminal.stocks.due_diligence.rst | 133 ++++++++ ...ental_analysis.financial_modeling_prep.rst | 37 ++ ...k_terminal.stocks.fundamental_analysis.rst | 157 +++++++++ .../gamestonk_terminal.stocks.government.rst | 37 ++ ...estonk_terminal.stocks.insider.presets.rst | 21 ++ .../gamestonk_terminal.stocks.insider.rst | 77 +++++ ..._terminal.stocks.prediction_techniques.rst | 21 ++ ..._terminal.stocks.quantitative_analysis.rst | 37 ++ .../gamestonk_terminal.stocks.research.rst | 21 ++ docs/code/gamestonk_terminal.stocks.rst | 50 +++ .../gamestonk_terminal.stocks.screener.rst | 45 +++ ...onk_terminal.stocks.technical_analysis.rst | 85 +++++ docs/code/modules.rst | 7 + docs/index.rst | 4 +- poetry.lock | 91 ++++- pyproject.toml | 3 +- requirements-full.txt | 36 +- requirements.txt | 4 +- 53 files changed, 3114 insertions(+), 339 deletions(-) create mode 100644 docs/README.md delete mode 100644 docs/code.rst create mode 100644 docs/code/gamestonk_terminal.common.behavioural_analysis.rst create mode 100644 docs/code/gamestonk_terminal.common.prediction_techniques.rst create mode 100644 docs/code/gamestonk_terminal.common.quantitative_analysis.rst create mode 100644 docs/code/gamestonk_terminal.common.rst create mode 100644 docs/code/gamestonk_terminal.common.technical_analysis.rst create mode 100644 docs/code/gamestonk_terminal.cryptocurrency.defi.rst create mode 100644 docs/code/gamestonk_terminal.cryptocurrency.discovery.rst create mode 100644 docs/code/gamestonk_terminal.cryptocurrency.due_diligence.rst create mode 100644 docs/code/gamestonk_terminal.cryptocurrency.onchain.rst create mode 100644 docs/code/gamestonk_terminal.cryptocurrency.overview.rst create mode 100644 docs/code/gamestonk_terminal.cryptocurrency.rst create mode 100644 docs/code/gamestonk_terminal.cryptocurrency.technical_analysis.rst create mode 100644 docs/code/gamestonk_terminal.economy.rst create mode 100644 docs/code/gamestonk_terminal.etf.rst create mode 100644 docs/code/gamestonk_terminal.forex.behavioural_analysis.rst create mode 100644 docs/code/gamestonk_terminal.forex.exploratory_data_analysis.rst create mode 100644 docs/code/gamestonk_terminal.forex.rst create mode 100644 docs/code/gamestonk_terminal.options.rst create mode 100644 docs/code/gamestonk_terminal.portfolio.brokers.coinbase.rst create mode 100644 docs/code/gamestonk_terminal.portfolio.brokers.degiro.rst create mode 100644 docs/code/gamestonk_terminal.portfolio.brokers.rst create mode 100644 docs/code/gamestonk_terminal.portfolio.portfolio_analysis.rst create mode 100644 docs/code/gamestonk_terminal.portfolio.portfolio_optimization.rst create mode 100644 docs/code/gamestonk_terminal.portfolio.rst create mode 100644 docs/code/gamestonk_terminal.reports.rst create mode 100644 docs/code/gamestonk_terminal.resources.rst create mode 100644 docs/code/gamestonk_terminal.rst create mode 100644 docs/code/gamestonk_terminal.stocks.backtesting.rst create mode 100644 docs/code/gamestonk_terminal.stocks.behavioural_analysis.rst create mode 100644 docs/code/gamestonk_terminal.stocks.comparison_analysis.rst create mode 100644 docs/code/gamestonk_terminal.stocks.dark_pool_shorts.rst create mode 100644 docs/code/gamestonk_terminal.stocks.discovery.rst create mode 100644 docs/code/gamestonk_terminal.stocks.due_diligence.rst create mode 100644 docs/code/gamestonk_terminal.stocks.fundamental_analysis.financial_modeling_prep.rst create mode 100644 docs/code/gamestonk_terminal.stocks.fundamental_analysis.rst create mode 100644 docs/code/gamestonk_terminal.stocks.government.rst create mode 100644 docs/code/gamestonk_terminal.stocks.insider.presets.rst create mode 100644 docs/code/gamestonk_terminal.stocks.insider.rst create mode 100644 docs/code/gamestonk_terminal.stocks.prediction_techniques.rst create mode 100644 docs/code/gamestonk_terminal.stocks.quantitative_analysis.rst create mode 100644 docs/code/gamestonk_terminal.stocks.research.rst create mode 100644 docs/code/gamestonk_terminal.stocks.rst create mode 100644 docs/code/gamestonk_terminal.stocks.screener.rst create mode 100644 docs/code/gamestonk_terminal.stocks.technical_analysis.rst create mode 100644 docs/code/modules.rst diff --git a/.gitignore b/.gitignore index 69c4a05332d..80fbea7e0c6 100644 --- a/.gitignore +++ b/.gitignore @@ -26,3 +26,6 @@ jupyterlab/*/.ipynb_checkpoints jupyterlab/*/*.tsbuildinfo jupyterlab/*/ui-tests/test-results/ jupyterlab/*/ui-tests/tests/*.ts-snapshots/ + +# Sphinx documentation build files +docs/_build diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000000..b7b62609e27 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,15 @@ +# Gamestonk Terminal Code Documentation + +Requirements: + +- sphinx +- myst_parser + +The `requirements.txt` file that mentions `myst_parser` is needed for readthedocs.io to build the documentation automatically. + +Usage: + +```bash +sphinx-apidoc ../gamestonk_terminal/ -o ./code +make html +``` diff --git a/docs/code.rst b/docs/code.rst deleted file mode 100644 index 13134f40f8f..00000000000 --- a/docs/code.rst +++ /dev/null @@ -1,316 +0,0 @@ -Class library and code comments -====================================== - -Root level files ----------------------------------- - -.. automodule:: gamestonk_terminal.feature_flags - :members: -.. automodule:: gamestonk_terminal.helper_funcs - :members: -.. automodule:: gamestonk_terminal.main_helper - :members: -.. automodule:: gamestonk_terminal.menu - :members: -.. automodule:: gamestonk_terminal.reddit_helpers - :members: -.. automodule:: gamestonk_terminal.res_menu - :members: -.. automodule:: gamestonk_terminal.test_helper - :members: -.. automodule:: gamestonk_terminal.thought_of_the_day - :members: -.. automodule:: gamestonk_terminal.config_neural_network_models - :members: -.. automodule:: gamestonk_terminal.config_plot - :members: -.. automodule:: gamestonk_terminal.config_terminal - :members: -.. automodule:: gamestonk_terminal.dataframe_helpers - :members: - - -Technical analysis -------------------- - -.. automodule:: gamestonk_terminal.technical_analysis.finbrain_view - :members: -.. automodule:: gamestonk_terminal.technical_analysis.finviz_view - :members: -.. automodule:: gamestonk_terminal.technical_analysis.momentum - :members: -.. automodule:: gamestonk_terminal.technical_analysis.overlap - :members: -.. automodule:: gamestonk_terminal.technical_analysis.ta_controller - :members: -.. automodule:: gamestonk_terminal.technical_analysis.tradingview_view - :members: -.. automodule:: gamestonk_terminal.technical_analysis.trend_indicators - :members: -.. automodule:: gamestonk_terminal.technical_analysis.trendline_api - :members: -.. automodule:: gamestonk_terminal.technical_analysis.volatility - :members: -.. automodule:: gamestonk_terminal.technical_analysis.volume - :members: - - -Stock screener --------------- - -.. automodule:: gamestonk_terminal.screener.finviz_view - :members: -.. automodule:: gamestonk_terminal.screener.screener_controller - :members: -.. automodule:: gamestonk_terminal.screener.yahoo_finance_view - :members: - - -Residual analysis ------------------ - -.. automodule:: gamestonk_terminal.residuals_analysis.ra_controller - :members: -.. automodule:: gamestonk_terminal.residuals_analysis.residuals_api - :members: -.. automodule:: gamestonk_terminal.residuals_analysis.residuals_model - :members: - - -Prediction techniques ---------------------- - -.. automodule:: gamestonk_terminal.prediction_techniques.arima - :members: -.. automodule:: gamestonk_terminal.prediction_techniques.ets - :members: -.. automodule:: gamestonk_terminal.prediction_techniques.knn - :members: -.. automodule:: gamestonk_terminal.prediction_techniques.neural_networks - :members: -.. automodule:: gamestonk_terminal.prediction_techniques.pred_controller - :members: -.. automodule:: gamestonk_terminal.prediction_techniques.pred_helper - :members: -.. automodule:: gamestonk_terminal.prediction_techniques.regression - :members: -.. automodule:: gamestonk_terminal.prediction_techniques.sma - :members: - - -Portfolio optimization ----------------------- - -.. automodule:: gamestonk_terminal.portfolio_optimization.optimizer_helper - :members: -.. automodule:: gamestonk_terminal.portfolio_optimization.optimizer_view - :members: -.. automodule:: gamestonk_terminal.portfolio_optimization.po_controller - :members: - - - -Behavioural analysis --------------------- - -.. automodule:: gamestonk_terminal.behavioural_analysis.ba_controller - :members: -.. automodule:: gamestonk_terminal.behavioural_analysis.finbrain_view - :members: -.. automodule:: gamestonk_terminal.behavioural_analysis.google_view - :members: -.. automodule:: gamestonk_terminal.behavioural_analysis.reddit_view - :members: -.. automodule:: gamestonk_terminal.behavioural_analysis.stocktwits_view - :members: -.. automodule:: gamestonk_terminal.behavioural_analysis.twitter_view - :members: - -Comparison analysis --------------------- - -.. automodule:: gamestonk_terminal.comparison_analysis.ca_controller - :members: -.. automodule:: gamestonk_terminal.comparison_analysis.finbrain_view - :members: -.. automodule:: gamestonk_terminal.comparison_analysis.finviz_compare_view - :members: -.. automodule:: gamestonk_terminal.comparison_analysis.market_watch_view - :members: -.. automodule:: gamestonk_terminal.comparison_analysis.yahoo_finance_view - :members: - - -Cryptocurrency --------------- - -.. automodule:: gamestonk_terminal.cryptocurrency.coinmarketcap_view - :members: -.. automodule:: gamestonk_terminal.cryptocurrency.crypto_controller - :members: -.. automodule:: gamestonk_terminal.cryptocurrency.crypto_helper - :members: - - -Discovery ---------- - -.. automodule:: gamestonk_terminal.discovery.alpha_vantage_view - :members: -.. automodule:: gamestonk_terminal.discovery.ark_model - :members: -.. automodule:: gamestonk_terminal.discovery.ark_view - :members: -.. automodule:: gamestonk_terminal.discovery.disc_controller - :members: -.. automodule:: gamestonk_terminal.discovery.fidelity_model - :members: -.. automodule:: gamestonk_terminal.discovery.fidelity_view - :members: -.. automodule:: gamestonk_terminal.discovery.finra_ats_view - :members: -.. automodule:: gamestonk_terminal.discovery.finviz_view - :members: -.. automodule:: gamestonk_terminal.discovery.marketbeat_model - :members: -.. automodule:: gamestonk_terminal.discovery.marketbeat_view - :members: -.. automodule:: gamestonk_terminal.discovery.seeking_alpha_model - :members: -.. automodule:: gamestonk_terminal.discovery.seeking_alpha_view - :members: -.. automodule:: gamestonk_terminal.discovery.short_interest_model - :members: -.. automodule:: gamestonk_terminal.discovery.short_interest_view - :members: -.. automodule:: gamestonk_terminal.discovery.simply_wallst_view - :members: -.. automodule:: gamestonk_terminal.discovery.spachero_view - :members: -.. automodule:: gamestonk_terminal.discovery.unusual_whales_view - :members: -.. automodule:: gamestonk_terminal.discovery.yahoo_finance_view - :members: - -Due diligence -------------- - -.. automodule:: gamestonk_terminal.due_diligence.business_insider_view - :members: -.. automodule:: gamestonk_terminal.due_diligence.dd_controller - :members: -.. automodule:: gamestonk_terminal.due_diligence.financial_modeling_prep_view - :members: -.. automodule:: gamestonk_terminal.due_diligence.finra_view - :members: -.. automodule:: gamestonk_terminal.due_diligence.finviz_view - :members: -.. automodule:: gamestonk_terminal.due_diligence.market_watch_view - :members: -.. automodule:: gamestonk_terminal.due_diligence.news_view - :members: -.. automodule:: gamestonk_terminal.due_diligence.quandl_view - :members: -.. automodule:: gamestonk_terminal.due_diligence.reddit_view - :members: -.. automodule:: gamestonk_terminal.due_diligence.sec_view - :members: - -Econ ------ - -.. automodule:: gamestonk_terminal.econ.econ_controller - :members: -.. automodule:: gamestonk_terminal.econ.fred_view - :members: -.. automodule:: gamestonk_terminal.econ.vix_view - :members: - -Exploratory data analysis -------------------------- - -.. automodule:: gamestonk_terminal.exploratory_data_analysis.eda_api - :members: -.. automodule:: gamestonk_terminal.exploratory_data_analysis.eda_controller - :members: - -Forex ------ - -.. automodule:: gamestonk_terminal.forex.fx_controller - :members: -.. automodule:: gamestonk_terminal.forex.fx_view - :members: - -Fundamental analysis --------------------- - -.. automodule:: gamestonk_terminal.fundamental_analysis.alpha_vantage_controller - :members: -.. automodule:: gamestonk_terminal.fundamental_analysis.alpha_vantage_view - :members: -.. automodule:: gamestonk_terminal.fundamental_analysis.business_insider_view - :members: -.. automodule:: gamestonk_terminal.fundamental_analysis.fa_controller - :members: -.. automodule:: gamestonk_terminal.fundamental_analysis.financial_modeling_prep_controller - :members: -.. automodule:: gamestonk_terminal.fundamental_analysis.financial_modeling_prep_view - :members: -.. automodule:: gamestonk_terminal.fundamental_analysis.finviz_view - :members: -.. automodule:: gamestonk_terminal.fundamental_analysis.market_watch_model - :members: -.. automodule:: gamestonk_terminal.fundamental_analysis.market_watch_view - :members: -.. automodule:: gamestonk_terminal.fundamental_analysis.yahoo_finance_view - :members: -.. automodule:: gamestonk_terminal.fundamental_analysis.yield_curve_model - :members: - -Options -------- - -.. automodule:: gamestonk_terminal.options.chains_view - :members: -.. automodule:: gamestonk_terminal.options.op_controller - :members: -.. automodule:: gamestonk_terminal.options.op_scrape_view - :members: -.. automodule:: gamestonk_terminal.options.volume_helper - :members: -.. automodule:: gamestonk_terminal.options.volume_view - :members: - -Papermill ---------- - -.. automodule:: gamestonk_terminal.papermill.due_diligence_view - :members: -.. automodule:: gamestonk_terminal.papermill.econ_data_helper - :members: -.. automodule:: gamestonk_terminal.papermill.econ_data_view - :members: -.. automodule:: gamestonk_terminal.papermill.papermill_controller - :members: - -Portfolio ----------- - -.. automodule:: gamestonk_terminal.portfolio.ally_api - :members: -.. automodule:: gamestonk_terminal.portfolio.alp_api - :members: -.. automodule:: gamestonk_terminal.portfolio.dg_api - :members: -.. automodule:: gamestonk_terminal.portfolio.port_controller - :members: -.. automodule:: gamestonk_terminal.portfolio.portfolio_helpers - :members: -.. automodule:: gamestonk_terminal.portfolio.rh_api - :members: - - - - - diff --git a/docs/code/gamestonk_terminal.common.behavioural_analysis.rst b/docs/code/gamestonk_terminal.common.behavioural_analysis.rst new file mode 100644 index 00000000000..4504ea5b870 --- /dev/null +++ b/docs/code/gamestonk_terminal.common.behavioural_analysis.rst @@ -0,0 +1,133 @@ +gamestonk\_terminal.common.behavioural\_analysis package +======================================================== + +Submodules +---------- + +gamestonk\_terminal.common.behavioural\_analysis.finbrain\_model module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.finbrain_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.finbrain\_view module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.finbrain_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.finnhub\_model module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.finnhub_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.finnhub\_view module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.finnhub_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.google\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.google_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.google\_view module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.google_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.reddit\_helpers module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.reddit_helpers + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.reddit\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.reddit_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.reddit\_view module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.reddit_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.sentimentinvestor\_model module +-------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.sentimentinvestor_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.sentimentinvestor\_view module +------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.sentimentinvestor_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.stocktwits\_model module +------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.stocktwits_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.stocktwits\_view module +------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.stocktwits_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.twitter\_model module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.twitter_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.behavioural\_analysis.twitter\_view module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis.twitter_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.common.behavioural_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.common.prediction_techniques.rst b/docs/code/gamestonk_terminal.common.prediction_techniques.rst new file mode 100644 index 00000000000..a0eac81de2e --- /dev/null +++ b/docs/code/gamestonk_terminal.common.prediction_techniques.rst @@ -0,0 +1,117 @@ +gamestonk\_terminal.common.prediction\_techniques package +========================================================= + +Submodules +---------- + +gamestonk\_terminal.common.prediction\_techniques.arima\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.prediction_techniques.arima_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.arima\_view module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.prediction_techniques.arima_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.ets\_model module +------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.prediction_techniques.ets_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.ets\_view module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.common.prediction_techniques.ets_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.knn\_model module +------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.prediction_techniques.knn_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.knn\_view module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.common.prediction_techniques.knn_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.mc\_model module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.common.prediction_techniques.mc_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.mc\_view module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.prediction_techniques.mc_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.neural\_networks\_model module +-------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.prediction_techniques.neural_networks_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.neural\_networks\_view module +------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.prediction_techniques.neural_networks_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.pred\_helper module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.prediction_techniques.pred_helper + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.regression\_model module +-------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.prediction_techniques.regression_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.prediction\_techniques.regression\_view module +------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.prediction_techniques.regression_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.common.prediction_techniques + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.common.quantitative_analysis.rst b/docs/code/gamestonk_terminal.common.quantitative_analysis.rst new file mode 100644 index 00000000000..6740c191ad0 --- /dev/null +++ b/docs/code/gamestonk_terminal.common.quantitative_analysis.rst @@ -0,0 +1,45 @@ +gamestonk\_terminal.common.quantitative\_analysis package +========================================================= + +Submodules +---------- + +gamestonk\_terminal.common.quantitative\_analysis.qa\_model module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.common.quantitative_analysis.qa_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.quantitative\_analysis.qa\_view module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.quantitative_analysis.qa_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.quantitative\_analysis.rolling\_model module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.quantitative_analysis.rolling_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.quantitative\_analysis.rolling\_view module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.quantitative_analysis.rolling_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.common.quantitative_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.common.rst b/docs/code/gamestonk_terminal.common.rst new file mode 100644 index 00000000000..974e94f7a45 --- /dev/null +++ b/docs/code/gamestonk_terminal.common.rst @@ -0,0 +1,32 @@ +gamestonk\_terminal.common package +================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + gamestonk_terminal.common.behavioural_analysis + gamestonk_terminal.common.prediction_techniques + gamestonk_terminal.common.quantitative_analysis + gamestonk_terminal.common.technical_analysis + +Submodules +---------- + +gamestonk\_terminal.common.newsapi\_view module +----------------------------------------------- + +.. automodule:: gamestonk_terminal.common.newsapi_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.common + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.common.technical_analysis.rst b/docs/code/gamestonk_terminal.common.technical_analysis.rst new file mode 100644 index 00000000000..e1351a5b92e --- /dev/null +++ b/docs/code/gamestonk_terminal.common.technical_analysis.rst @@ -0,0 +1,117 @@ +gamestonk\_terminal.common.technical\_analysis package +====================================================== + +Submodules +---------- + +gamestonk\_terminal.common.technical\_analysis.custom\_indicators\_model module +------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.technical_analysis.custom_indicators_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.custom\_indicators\_view module +------------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.common.technical_analysis.custom_indicators_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.momentum\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.technical_analysis.momentum_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.momentum\_view module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.technical_analysis.momentum_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.overlap\_model module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.technical_analysis.overlap_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.overlap\_view module +------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.technical_analysis.overlap_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.trend\_indicators\_model module +------------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.common.technical_analysis.trend_indicators_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.trend\_indicators\_view module +----------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.technical_analysis.trend_indicators_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.trendline\_api module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.technical_analysis.trendline_api + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.volatility\_model module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.technical_analysis.volatility_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.volatility\_view module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.technical_analysis.volatility_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.volume\_model module +------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.common.technical_analysis.volume_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.common.technical\_analysis.volume\_view module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.common.technical_analysis.volume_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.common.technical_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.cryptocurrency.defi.rst b/docs/code/gamestonk_terminal.cryptocurrency.defi.rst new file mode 100644 index 00000000000..a896e1ad60b --- /dev/null +++ b/docs/code/gamestonk_terminal.cryptocurrency.defi.rst @@ -0,0 +1,85 @@ +gamestonk\_terminal.cryptocurrency.defi package +=============================================== + +Submodules +---------- + +gamestonk\_terminal.cryptocurrency.defi.defi\_controller module +--------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.defi.defi_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.defi.defipulse\_model module +--------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.defi.defipulse_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.defi.defipulse\_view module +-------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.defi.defipulse_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.defi.defirate\_model module +-------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.defi.defirate_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.defi.defirate\_view module +------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.defi.defirate_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.defi.llama\_model module +----------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.defi.llama_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.defi.llama\_view module +---------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.defi.llama_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.defi.substack\_model module +-------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.defi.substack_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.defi.substack\_view module +------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.defi.substack_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.defi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.cryptocurrency.discovery.rst b/docs/code/gamestonk_terminal.cryptocurrency.discovery.rst new file mode 100644 index 00000000000..02b632d8047 --- /dev/null +++ b/docs/code/gamestonk_terminal.cryptocurrency.discovery.rst @@ -0,0 +1,69 @@ +gamestonk\_terminal.cryptocurrency.discovery package +==================================================== + +Submodules +---------- + +gamestonk\_terminal.cryptocurrency.discovery.coinmarketcap\_model module +------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.cryptocurrency.discovery.coinmarketcap_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.discovery.coinmarketcap\_view module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.discovery.coinmarketcap_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.discovery.coinpaprika\_model module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.discovery.coinpaprika_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.discovery.coinpaprika\_view module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.discovery.coinpaprika_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.discovery.discovery\_controller module +------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.discovery.discovery_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.discovery.pycoingecko\_model module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.discovery.pycoingecko_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.discovery.pycoingecko\_view module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.discovery.pycoingecko_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.discovery + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.cryptocurrency.due_diligence.rst b/docs/code/gamestonk_terminal.cryptocurrency.due_diligence.rst new file mode 100644 index 00000000000..32cea3c71f4 --- /dev/null +++ b/docs/code/gamestonk_terminal.cryptocurrency.due_diligence.rst @@ -0,0 +1,109 @@ +gamestonk\_terminal.cryptocurrency.due\_diligence package +========================================================= + +Submodules +---------- + +gamestonk\_terminal.cryptocurrency.due\_diligence.binance\_model module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.binance_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.due\_diligence.binance\_view module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.binance_view + :members: + :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 +------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.coinbase_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.due\_diligence.coinbase\_view module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.coinbase_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.due\_diligence.coinpaprika\_model module +--------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.coinpaprika_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.due\_diligence.coinpaprika\_view module +-------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.coinpaprika_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.due\_diligence.dd\_controller module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.dd_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.due\_diligence.finbrain\_crypto\_view module +------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.finbrain_crypto_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.due\_diligence.pycoingecko\_model module +--------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.pycoingecko_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.due\_diligence.pycoingecko\_view module +-------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence.pycoingecko_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.due_diligence + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.cryptocurrency.onchain.rst b/docs/code/gamestonk_terminal.cryptocurrency.onchain.rst new file mode 100644 index 00000000000..dfe3c4c22c8 --- /dev/null +++ b/docs/code/gamestonk_terminal.cryptocurrency.onchain.rst @@ -0,0 +1,85 @@ +gamestonk\_terminal.cryptocurrency.onchain package +================================================== + +Submodules +---------- + +gamestonk\_terminal.cryptocurrency.onchain.ethgasstation\_model module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.onchain.ethgasstation_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.onchain.ethgasstation\_view module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.onchain.ethgasstation_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.onchain.ethplorer\_model module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.cryptocurrency.onchain.ethplorer_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.onchain.ethplorer\_view module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.onchain.ethplorer_view + :members: + :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 +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.onchain.onchain_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.onchain.whale\_alert\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.onchain.whale_alert_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.onchain.whale\_alert\_view module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.onchain.whale_alert_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.onchain + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.cryptocurrency.overview.rst b/docs/code/gamestonk_terminal.cryptocurrency.overview.rst new file mode 100644 index 00000000000..4b7e50e21ef --- /dev/null +++ b/docs/code/gamestonk_terminal.cryptocurrency.overview.rst @@ -0,0 +1,69 @@ +gamestonk\_terminal.cryptocurrency.overview package +=================================================== + +Submodules +---------- + +gamestonk\_terminal.cryptocurrency.overview.coinbase\_model module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.cryptocurrency.overview.coinbase_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.overview.coinbase\_view module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.overview.coinbase_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.overview.coinpaprika\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.overview.coinpaprika_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.overview.coinpaprika\_view module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.overview.coinpaprika_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.overview.overview\_controller module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.overview.overview_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.overview.pycoingecko\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.overview.pycoingecko_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.overview.pycoingecko\_view module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.overview.pycoingecko_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.overview + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.cryptocurrency.rst b/docs/code/gamestonk_terminal.cryptocurrency.rst new file mode 100644 index 00000000000..f1f6f634c4b --- /dev/null +++ b/docs/code/gamestonk_terminal.cryptocurrency.rst @@ -0,0 +1,74 @@ +gamestonk\_terminal.cryptocurrency package +========================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + gamestonk_terminal.cryptocurrency.defi + gamestonk_terminal.cryptocurrency.discovery + gamestonk_terminal.cryptocurrency.due_diligence + gamestonk_terminal.cryptocurrency.onchain + gamestonk_terminal.cryptocurrency.overview + gamestonk_terminal.cryptocurrency.technical_analysis + +Submodules +---------- + +gamestonk\_terminal.cryptocurrency.coinbase\_helpers module +----------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.coinbase_helpers + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.coinpaprika\_helpers module +-------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.coinpaprika_helpers + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.crypto\_controller module +------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.cryptocurrency.crypto_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.cryptocurrency\_helpers module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.cryptocurrency_helpers + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.dataframe\_helpers module +------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.cryptocurrency.dataframe_helpers + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.cryptocurrency.pycoingecko\_helpers module +-------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.pycoingecko_helpers + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.cryptocurrency + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.cryptocurrency.technical_analysis.rst b/docs/code/gamestonk_terminal.cryptocurrency.technical_analysis.rst new file mode 100644 index 00000000000..f849d537674 --- /dev/null +++ b/docs/code/gamestonk_terminal.cryptocurrency.technical_analysis.rst @@ -0,0 +1,21 @@ +gamestonk\_terminal.cryptocurrency.technical\_analysis package +============================================================== + +Submodules +---------- + +gamestonk\_terminal.cryptocurrency.technical\_analysis.ta\_controller module +---------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.technical_analysis.ta_controller + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.cryptocurrency.technical_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.economy.rst b/docs/code/gamestonk_terminal.economy.rst new file mode 100644 index 00000000000..231363b4579 --- /dev/null +++ b/docs/code/gamestonk_terminal.economy.rst @@ -0,0 +1,125 @@ +gamestonk\_terminal.economy package +=================================== + +Submodules +---------- + +gamestonk\_terminal.economy.alphavantage\_model module +------------------------------------------------------ + +.. automodule:: gamestonk_terminal.economy.alphavantage_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.alphavantage\_view module +----------------------------------------------------- + +.. automodule:: gamestonk_terminal.economy.alphavantage_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.cnn\_model module +--------------------------------------------- + +.. automodule:: gamestonk_terminal.economy.cnn_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.cnn\_view module +-------------------------------------------- + +.. automodule:: gamestonk_terminal.economy.cnn_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.econ\_data\_helper module +----------------------------------------------------- + +.. automodule:: gamestonk_terminal.economy.econ_data_helper + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.economy\_controller module +------------------------------------------------------ + +.. automodule:: gamestonk_terminal.economy.economy_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.finnhub\_model module +------------------------------------------------- + +.. automodule:: gamestonk_terminal.economy.finnhub_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.finnhub\_view module +------------------------------------------------ + +.. automodule:: gamestonk_terminal.economy.finnhub_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.finviz\_model module +------------------------------------------------ + +.. automodule:: gamestonk_terminal.economy.finviz_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.finviz\_view module +----------------------------------------------- + +.. automodule:: gamestonk_terminal.economy.finviz_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.fred\_model module +---------------------------------------------- + +.. automodule:: gamestonk_terminal.economy.fred_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.fred\_view module +--------------------------------------------- + +.. automodule:: gamestonk_terminal.economy.fred_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.wsj\_model module +--------------------------------------------- + +.. automodule:: gamestonk_terminal.economy.wsj_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.economy.wsj\_view module +-------------------------------------------- + +.. automodule:: gamestonk_terminal.economy.wsj_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.economy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.etf.rst b/docs/code/gamestonk_terminal.etf.rst new file mode 100644 index 00000000000..4727412f037 --- /dev/null +++ b/docs/code/gamestonk_terminal.etf.rst @@ -0,0 +1,77 @@ +gamestonk\_terminal.etf package +=============================== + +Submodules +---------- + +gamestonk\_terminal.etf.etf\_controller module +---------------------------------------------- + +.. automodule:: gamestonk_terminal.etf.etf_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.etf.financedatabase\_view module +---------------------------------------------------- + +.. automodule:: gamestonk_terminal.etf.financedatabase_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.etf.screener\_model module +---------------------------------------------- + +.. automodule:: gamestonk_terminal.etf.screener_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.etf.screener\_view module +--------------------------------------------- + +.. automodule:: gamestonk_terminal.etf.screener_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.etf.stockanalysis\_model module +--------------------------------------------------- + +.. automodule:: gamestonk_terminal.etf.stockanalysis_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.etf.stockanalysis\_view module +-------------------------------------------------- + +.. automodule:: gamestonk_terminal.etf.stockanalysis_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.etf.wsj\_model module +----------------------------------------- + +.. automodule:: gamestonk_terminal.etf.wsj_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.etf.wsj\_view module +---------------------------------------- + +.. automodule:: gamestonk_terminal.etf.wsj_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.etf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.forex.behavioural_analysis.rst b/docs/code/gamestonk_terminal.forex.behavioural_analysis.rst new file mode 100644 index 00000000000..267a3700a59 --- /dev/null +++ b/docs/code/gamestonk_terminal.forex.behavioural_analysis.rst @@ -0,0 +1,21 @@ +gamestonk\_terminal.forex.behavioural\_analysis package +======================================================= + +Submodules +---------- + +gamestonk\_terminal.forex.behavioural\_analysis.ba\_controller module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.forex.behavioural_analysis.ba_controller + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.forex.behavioural_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.forex.exploratory_data_analysis.rst b/docs/code/gamestonk_terminal.forex.exploratory_data_analysis.rst new file mode 100644 index 00000000000..f54c5f6e79f --- /dev/null +++ b/docs/code/gamestonk_terminal.forex.exploratory_data_analysis.rst @@ -0,0 +1,21 @@ +gamestonk\_terminal.forex.exploratory\_data\_analysis package +============================================================= + +Submodules +---------- + +gamestonk\_terminal.forex.exploratory\_data\_analysis.eda\_controller module +---------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.forex.exploratory_data_analysis.eda_controller + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.forex.exploratory_data_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.forex.rst b/docs/code/gamestonk_terminal.forex.rst new file mode 100644 index 00000000000..5a5b071fa2e --- /dev/null +++ b/docs/code/gamestonk_terminal.forex.rst @@ -0,0 +1,38 @@ +gamestonk\_terminal.forex package +================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + gamestonk_terminal.forex.behavioural_analysis + gamestonk_terminal.forex.exploratory_data_analysis + +Submodules +---------- + +gamestonk\_terminal.forex.forex\_controller module +-------------------------------------------------- + +.. automodule:: gamestonk_terminal.forex.forex_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.forex.fx\_view module +----------------------------------------- + +.. automodule:: gamestonk_terminal.forex.fx_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.forex + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.options.rst b/docs/code/gamestonk_terminal.options.rst new file mode 100644 index 00000000000..6d75b417b6f --- /dev/null +++ b/docs/code/gamestonk_terminal.options.rst @@ -0,0 +1,165 @@ +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: diff --git a/docs/code/gamestonk_terminal.portfolio.brokers.coinbase.rst b/docs/code/gamestonk_terminal.portfolio.brokers.coinbase.rst new file mode 100644 index 00000000000..fac13d43be3 --- /dev/null +++ b/docs/code/gamestonk_terminal.portfolio.brokers.coinbase.rst @@ -0,0 +1,37 @@ +gamestonk\_terminal.portfolio.brokers.coinbase package +====================================================== + +Submodules +---------- + +gamestonk\_terminal.portfolio.brokers.coinbase.coinbase\_controller module +-------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.brokers.coinbase.coinbase_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.brokers.coinbase.coinbase\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.brokers.coinbase.coinbase_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.brokers.coinbase.coinbase\_view module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.brokers.coinbase.coinbase_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.portfolio.brokers.coinbase + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.portfolio.brokers.degiro.rst b/docs/code/gamestonk_terminal.portfolio.brokers.degiro.rst new file mode 100644 index 00000000000..36288fc5752 --- /dev/null +++ b/docs/code/gamestonk_terminal.portfolio.brokers.degiro.rst @@ -0,0 +1,37 @@ +gamestonk\_terminal.portfolio.brokers.degiro package +==================================================== + +Submodules +---------- + +gamestonk\_terminal.portfolio.brokers.degiro.degiro\_controller module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.brokers.degiro.degiro_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.brokers.degiro.degiro\_model module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.brokers.degiro.degiro_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.brokers.degiro.degiro\_view module +---------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.brokers.degiro.degiro_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.portfolio.brokers.degiro + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.portfolio.brokers.rst b/docs/code/gamestonk_terminal.portfolio.brokers.rst new file mode 100644 index 00000000000..338de6e21f3 --- /dev/null +++ b/docs/code/gamestonk_terminal.portfolio.brokers.rst @@ -0,0 +1,38 @@ +gamestonk\_terminal.portfolio.brokers package +============================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + gamestonk_terminal.portfolio.brokers.coinbase + gamestonk_terminal.portfolio.brokers.degiro + +Submodules +---------- + +gamestonk\_terminal.portfolio.brokers.bro\_controller module +------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.portfolio.brokers.bro_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.brokers.brokers\_helpers module +------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.brokers.brokers_helpers + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.portfolio.brokers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.portfolio.portfolio_analysis.rst b/docs/code/gamestonk_terminal.portfolio.portfolio_analysis.rst new file mode 100644 index 00000000000..7755169609d --- /dev/null +++ b/docs/code/gamestonk_terminal.portfolio.portfolio_analysis.rst @@ -0,0 +1,37 @@ +gamestonk\_terminal.portfolio.portfolio\_analysis package +========================================================= + +Submodules +---------- + +gamestonk\_terminal.portfolio.portfolio\_analysis.pa\_controller module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.portfolio_analysis.pa_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.portfolio\_analysis.portfolio\_model module +------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.portfolio_analysis.portfolio_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.portfolio\_analysis.portfolio\_view module +------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.portfolio.portfolio_analysis.portfolio_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.portfolio.portfolio_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.portfolio.portfolio_optimization.rst b/docs/code/gamestonk_terminal.portfolio.portfolio_optimization.rst new file mode 100644 index 00000000000..ddf772e8f0f --- /dev/null +++ b/docs/code/gamestonk_terminal.portfolio.portfolio_optimization.rst @@ -0,0 +1,53 @@ +gamestonk\_terminal.portfolio.portfolio\_optimization package +============================================================= + +Submodules +---------- + +gamestonk\_terminal.portfolio.portfolio\_optimization.optimizer\_helper module +------------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.portfolio.portfolio_optimization.optimizer_helper + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.portfolio\_optimization.optimizer\_model module +----------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.portfolio_optimization.optimizer_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.portfolio\_optimization.optimizer\_view module +---------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.portfolio_optimization.optimizer_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.portfolio\_optimization.po\_controller module +--------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.portfolio_optimization.po_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.portfolio\_optimization.yahoo\_finance\_model module +---------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.portfolio_optimization.yahoo_finance_model + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.portfolio.portfolio_optimization + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.portfolio.rst b/docs/code/gamestonk_terminal.portfolio.rst new file mode 100644 index 00000000000..1ab4ba6a85e --- /dev/null +++ b/docs/code/gamestonk_terminal.portfolio.rst @@ -0,0 +1,71 @@ +gamestonk\_terminal.portfolio package +===================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + gamestonk_terminal.portfolio.brokers + gamestonk_terminal.portfolio.portfolio_analysis + gamestonk_terminal.portfolio.portfolio_optimization + +Submodules +---------- + +gamestonk\_terminal.portfolio.portfolio\_controller module +---------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.portfolio_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.portfolio\_helper module +------------------------------------------------------ + +.. automodule:: gamestonk_terminal.portfolio.portfolio_helper + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.portfolio\_model module +----------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.portfolio_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.portfolio\_view module +---------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.portfolio_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.reportlab\_helpers module +------------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.reportlab_helpers + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.portfolio.yfinance\_model module +---------------------------------------------------- + +.. automodule:: gamestonk_terminal.portfolio.yfinance_model + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.portfolio + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.reports.rst b/docs/code/gamestonk_terminal.reports.rst new file mode 100644 index 00000000000..ebff9bc6103 --- /dev/null +++ b/docs/code/gamestonk_terminal.reports.rst @@ -0,0 +1,21 @@ +gamestonk\_terminal.reports package +=================================== + +Submodules +---------- + +gamestonk\_terminal.reports.reports\_controller module +------------------------------------------------------ + +.. automodule:: gamestonk_terminal.reports.reports_controller + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.reports + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.resources.rst b/docs/code/gamestonk_terminal.resources.rst new file mode 100644 index 00000000000..6b2a73864e0 --- /dev/null +++ b/docs/code/gamestonk_terminal.resources.rst @@ -0,0 +1,21 @@ +gamestonk\_terminal.resources package +===================================== + +Submodules +---------- + +gamestonk\_terminal.resources.resources\_controller module +---------------------------------------------------------- + +.. automodule:: gamestonk_terminal.resources.resources_controller + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.resources + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.rst b/docs/code/gamestonk_terminal.rst new file mode 100644 index 00000000000..6931a78c753 --- /dev/null +++ b/docs/code/gamestonk_terminal.rst @@ -0,0 +1,102 @@ +gamestonk\_terminal package +=========================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + gamestonk_terminal.common + gamestonk_terminal.cryptocurrency + gamestonk_terminal.economy + gamestonk_terminal.etf + gamestonk_terminal.forex + gamestonk_terminal.options + gamestonk_terminal.portfolio + gamestonk_terminal.reports + gamestonk_terminal.resources + gamestonk_terminal.stocks + +Submodules +---------- + +gamestonk\_terminal.config\_neural\_network\_models module +---------------------------------------------------------- + +.. automodule:: gamestonk_terminal.config_neural_network_models + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.config\_plot module +--------------------------------------- + +.. automodule:: gamestonk_terminal.config_plot + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.config\_terminal module +------------------------------------------- + +.. automodule:: gamestonk_terminal.config_terminal + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.feature\_flags module +----------------------------------------- + +.. automodule:: gamestonk_terminal.feature_flags + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.helper\_funcs module +---------------------------------------- + +.. automodule:: gamestonk_terminal.helper_funcs + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.menu module +------------------------------- + +.. automodule:: gamestonk_terminal.menu + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.terminal\_helper module +------------------------------------------- + +.. automodule:: gamestonk_terminal.terminal_helper + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.test\_helper module +--------------------------------------- + +.. automodule:: gamestonk_terminal.test_helper + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.thought\_of\_the\_day module +------------------------------------------------ + +.. automodule:: gamestonk_terminal.thought_of_the_day + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.backtesting.rst b/docs/code/gamestonk_terminal.stocks.backtesting.rst new file mode 100644 index 00000000000..24d112a9ce3 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.backtesting.rst @@ -0,0 +1,37 @@ +gamestonk\_terminal.stocks.backtesting package +============================================== + +Submodules +---------- + +gamestonk\_terminal.stocks.backtesting.bt\_controller module +------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.backtesting.bt_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.backtesting.bt\_model module +------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.backtesting.bt_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.backtesting.bt\_view module +------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.backtesting.bt_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.backtesting + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.behavioural_analysis.rst b/docs/code/gamestonk_terminal.stocks.behavioural_analysis.rst new file mode 100644 index 00000000000..36b8ced02ac --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.behavioural_analysis.rst @@ -0,0 +1,21 @@ +gamestonk\_terminal.stocks.behavioural\_analysis package +======================================================== + +Submodules +---------- + +gamestonk\_terminal.stocks.behavioural\_analysis.ba\_controller module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.behavioural_analysis.ba_controller + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.behavioural_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.comparison_analysis.rst b/docs/code/gamestonk_terminal.stocks.comparison_analysis.rst new file mode 100644 index 00000000000..58e95679df1 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.comparison_analysis.rst @@ -0,0 +1,101 @@ +gamestonk\_terminal.stocks.comparison\_analysis package +======================================================= + +Submodules +---------- + +gamestonk\_terminal.stocks.comparison\_analysis.ca\_controller module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis.ca_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.comparison\_analysis.finbrain\_model module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis.finbrain_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.comparison\_analysis.finbrain\_view module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis.finbrain_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.comparison\_analysis.finnhub\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis.finnhub_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.comparison\_analysis.finviz\_compare\_model module +----------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis.finviz_compare_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.comparison\_analysis.finviz\_compare\_view module +---------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis.finviz_compare_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.comparison\_analysis.marketwatch\_model module +------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis.marketwatch_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.comparison\_analysis.marketwatch\_view module +------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis.marketwatch_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.comparison\_analysis.polygon\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis.polygon_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.comparison\_analysis.yahoo\_finance\_model module +---------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis.yahoo_finance_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.comparison\_analysis.yahoo\_finance\_view module +--------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis.yahoo_finance_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.comparison_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.dark_pool_shorts.rst b/docs/code/gamestonk_terminal.stocks.dark_pool_shorts.rst new file mode 100644 index 00000000000..e85456fe3e6 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.dark_pool_shorts.rst @@ -0,0 +1,117 @@ +gamestonk\_terminal.stocks.dark\_pool\_shorts package +===================================================== + +Submodules +---------- + +gamestonk\_terminal.stocks.dark\_pool\_shorts.dps\_controller module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.dps_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.finra\_model module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.finra_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.finra\_view module +---------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.finra_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.quandl\_model module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.quandl_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.quandl\_view module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.quandl_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.sec\_model module +--------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.sec_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.sec\_view module +-------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.sec_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.shortinterest\_model module +------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.shortinterest_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.shortinterest\_view module +------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.shortinterest_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.stockgrid\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.stockgrid_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.stockgrid\_view module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.stockgrid_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.yahoofinance\_model module +------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.yahoofinance_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.dark\_pool\_shorts.yahoofinance\_view module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts.yahoofinance_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.dark_pool_shorts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.discovery.rst b/docs/code/gamestonk_terminal.stocks.discovery.rst new file mode 100644 index 00000000000..d235d39d861 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.discovery.rst @@ -0,0 +1,157 @@ +gamestonk\_terminal.stocks.discovery package +============================================ + +Submodules +---------- + +gamestonk\_terminal.stocks.discovery.ark\_model module +------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.discovery.ark_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.ark\_view module +----------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.ark_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.disc\_controller module +------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.discovery.disc_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.fidelity\_model module +----------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.fidelity_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.fidelity\_view module +---------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.fidelity_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.financedatabase\_view module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.financedatabase_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.finnhub\_model module +---------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.finnhub_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.finnhub\_view module +--------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.finnhub_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.geekofwallstreet\_model module +------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.geekofwallstreet_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.geekofwallstreet\_view module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.discovery.geekofwallstreet_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.marketbeat\_model module +------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.marketbeat_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.marketbeat\_view module +------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.discovery.marketbeat_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.seeking\_alpha\_model module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.seeking_alpha_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.seeking\_alpha\_view module +---------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.seeking_alpha_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.shortinterest\_model module +---------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.shortinterest_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.shortinterest\_view module +--------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.shortinterest_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.yahoofinance\_model module +--------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.yahoofinance_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.discovery.yahoofinance\_view module +-------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.discovery.yahoofinance_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.discovery + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.due_diligence.rst b/docs/code/gamestonk_terminal.stocks.due_diligence.rst new file mode 100644 index 00000000000..a3aeb42521c --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.due_diligence.rst @@ -0,0 +1,133 @@ +gamestonk\_terminal.stocks.due\_diligence package +================================================= + +Submodules +---------- + +gamestonk\_terminal.stocks.due\_diligence.ark\_model module +----------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.ark_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.ark\_view module +---------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.ark_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.business\_insider\_model module +------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.business_insider_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.business\_insider\_view module +------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.due_diligence.business_insider_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.csimarket\_model module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.csimarket_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.csimarket\_view module +---------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.csimarket_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.dd\_controller module +--------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.dd_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.finnhub\_model module +--------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.finnhub_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.finnhub\_view module +-------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.finnhub_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.finviz\_model module +-------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.finviz_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.finviz\_view module +------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.finviz_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.fmp\_model module +----------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.fmp_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.fmp\_view module +---------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.fmp_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.marketwatch\_model module +------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence.marketwatch_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.due\_diligence.marketwatch\_view module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.due_diligence.marketwatch_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.due_diligence + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.fundamental_analysis.financial_modeling_prep.rst b/docs/code/gamestonk_terminal.stocks.fundamental_analysis.financial_modeling_prep.rst new file mode 100644 index 00000000000..4a16f8ce602 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.fundamental_analysis.financial_modeling_prep.rst @@ -0,0 +1,37 @@ +gamestonk\_terminal.stocks.fundamental\_analysis.financial\_modeling\_prep package +================================================================================== + +Submodules +---------- + +gamestonk\_terminal.stocks.fundamental\_analysis.financial\_modeling\_prep.fmp\_controller module +------------------------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.financial_modeling_prep.fmp_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.financial\_modeling\_prep.fmp\_model module +-------------------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.financial_modeling_prep.fmp_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.financial\_modeling\_prep.fmp\_view module +------------------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.financial_modeling_prep.fmp_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.financial_modeling_prep + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.fundamental_analysis.rst b/docs/code/gamestonk_terminal.stocks.fundamental_analysis.rst new file mode 100644 index 00000000000..30bc0193f29 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.fundamental_analysis.rst @@ -0,0 +1,157 @@ +gamestonk\_terminal.stocks.fundamental\_analysis package +======================================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + gamestonk_terminal.stocks.fundamental_analysis.financial_modeling_prep + +Submodules +---------- + +gamestonk\_terminal.stocks.fundamental\_analysis.av\_model module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.av_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.av\_view module +---------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.av_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.business\_insider\_model module +-------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.business_insider_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.business\_insider\_view module +------------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.business_insider_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.dcf\_model module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.dcf_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.dcf\_view module +----------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.dcf_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.eclect\_us\_model module +------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.eclect_us_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.eclect\_us\_view module +------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.eclect_us_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.fa\_controller module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.fa_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.fa\_helper module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.fa_helper + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.finviz\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.finviz_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.finviz\_view module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.finviz_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.market\_watch\_model module +---------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.market_watch_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.market\_watch\_view module +--------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.market_watch_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.yahoo\_finance\_model module +----------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.yahoo_finance_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.yahoo\_finance\_view module +---------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.yahoo_finance_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.fundamental\_analysis.yield\_curve\_model module +--------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis.yield_curve_model + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.fundamental_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.government.rst b/docs/code/gamestonk_terminal.stocks.government.rst new file mode 100644 index 00000000000..2c36977723e --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.government.rst @@ -0,0 +1,37 @@ +gamestonk\_terminal.stocks.government package +============================================= + +Submodules +---------- + +gamestonk\_terminal.stocks.government.gov\_controller module +------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.government.gov_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.government.quiverquant\_model module +--------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.government.quiverquant_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.government.quiverquant\_view module +-------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.government.quiverquant_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.government + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.insider.presets.rst b/docs/code/gamestonk_terminal.stocks.insider.presets.rst new file mode 100644 index 00000000000..c23239e0351 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.insider.presets.rst @@ -0,0 +1,21 @@ +gamestonk\_terminal.stocks.insider.presets package +================================================== + +Submodules +---------- + +gamestonk\_terminal.stocks.insider.presets.test module +------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.insider.presets.test + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.insider.presets + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.insider.rst b/docs/code/gamestonk_terminal.stocks.insider.rst new file mode 100644 index 00000000000..9aa99c47bc2 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.insider.rst @@ -0,0 +1,77 @@ +gamestonk\_terminal.stocks.insider package +========================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + gamestonk_terminal.stocks.insider.presets + +Submodules +---------- + +gamestonk\_terminal.stocks.insider.businessinsider\_model module +---------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.insider.businessinsider_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.insider.businessinsider\_view module +--------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.insider.businessinsider_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.insider.finviz\_model module +------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.insider.finviz_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.insider.finviz\_view module +------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.insider.finviz_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.insider.insider\_controller module +------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.insider.insider_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.insider.openinsider\_model module +------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.insider.openinsider_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.insider.openinsider\_view module +----------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.insider.openinsider_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.insider + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.prediction_techniques.rst b/docs/code/gamestonk_terminal.stocks.prediction_techniques.rst new file mode 100644 index 00000000000..29fd4981dcd --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.prediction_techniques.rst @@ -0,0 +1,21 @@ +gamestonk\_terminal.stocks.prediction\_techniques package +========================================================= + +Submodules +---------- + +gamestonk\_terminal.stocks.prediction\_techniques.pred\_controller module +------------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.prediction_techniques.pred_controller + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.prediction_techniques + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.quantitative_analysis.rst b/docs/code/gamestonk_terminal.stocks.quantitative_analysis.rst new file mode 100644 index 00000000000..f19eed16997 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.quantitative_analysis.rst @@ -0,0 +1,37 @@ +gamestonk\_terminal.stocks.quantitative\_analysis package +========================================================= + +Submodules +---------- + +gamestonk\_terminal.stocks.quantitative\_analysis.factors\_model module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.quantitative_analysis.factors_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.quantitative\_analysis.factors\_view module +---------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.quantitative_analysis.factors_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.quantitative\_analysis.qa\_controller module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.quantitative_analysis.qa_controller + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.quantitative_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.research.rst b/docs/code/gamestonk_terminal.stocks.research.rst new file mode 100644 index 00000000000..fb0e78bd3b0 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.research.rst @@ -0,0 +1,21 @@ +gamestonk\_terminal.stocks.research package +=========================================== + +Submodules +---------- + +gamestonk\_terminal.stocks.research.res\_controller module +---------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.research.res_controller + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.research + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.rst b/docs/code/gamestonk_terminal.stocks.rst new file mode 100644 index 00000000000..91bb3cae77a --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.rst @@ -0,0 +1,50 @@ +gamestonk\_terminal.stocks package +================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + gamestonk_terminal.stocks.backtesting + gamestonk_terminal.stocks.behavioural_analysis + gamestonk_terminal.stocks.comparison_analysis + gamestonk_terminal.stocks.dark_pool_shorts + gamestonk_terminal.stocks.discovery + gamestonk_terminal.stocks.due_diligence + gamestonk_terminal.stocks.fundamental_analysis + gamestonk_terminal.stocks.government + gamestonk_terminal.stocks.insider + gamestonk_terminal.stocks.prediction_techniques + gamestonk_terminal.stocks.quantitative_analysis + gamestonk_terminal.stocks.research + gamestonk_terminal.stocks.screener + gamestonk_terminal.stocks.technical_analysis + +Submodules +---------- + +gamestonk\_terminal.stocks.stocks\_controller module +---------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.stocks_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.stocks\_helper module +------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.stocks_helper + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.screener.rst b/docs/code/gamestonk_terminal.stocks.screener.rst new file mode 100644 index 00000000000..66a90ce5734 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.screener.rst @@ -0,0 +1,45 @@ +gamestonk\_terminal.stocks.screener package +=========================================== + +Submodules +---------- + +gamestonk\_terminal.stocks.screener.finviz\_model module +-------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.screener.finviz_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.screener.finviz\_view module +------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.screener.finviz_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.screener.screener\_controller module +--------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.screener.screener_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.screener.yahoofinance\_view module +------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.screener.yahoofinance_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.screener + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/gamestonk_terminal.stocks.technical_analysis.rst b/docs/code/gamestonk_terminal.stocks.technical_analysis.rst new file mode 100644 index 00000000000..2a83ed92cd4 --- /dev/null +++ b/docs/code/gamestonk_terminal.stocks.technical_analysis.rst @@ -0,0 +1,85 @@ +gamestonk\_terminal.stocks.technical\_analysis package +====================================================== + +Submodules +---------- + +gamestonk\_terminal.stocks.technical\_analysis.finbrain\_model module +--------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.technical_analysis.finbrain_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.technical\_analysis.finbrain\_view module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.technical_analysis.finbrain_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.technical\_analysis.finnhub\_model module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.technical_analysis.finnhub_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.technical\_analysis.finnhub\_view module +------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.technical_analysis.finnhub_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.technical\_analysis.finviz\_model module +------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.technical_analysis.finviz_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.technical\_analysis.finviz\_view module +------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.technical_analysis.finviz_view + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.technical\_analysis.ta\_controller module +-------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.technical_analysis.ta_controller + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.technical\_analysis.tradingview\_model module +------------------------------------------------------------------------ + +.. automodule:: gamestonk_terminal.stocks.technical_analysis.tradingview_model + :members: + :undoc-members: + :show-inheritance: + +gamestonk\_terminal.stocks.technical\_analysis.tradingview\_view module +----------------------------------------------------------------------- + +.. automodule:: gamestonk_terminal.stocks.technical_analysis.tradingview_view + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: gamestonk_terminal.stocks.technical_analysis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code/modules.rst b/docs/code/modules.rst new file mode 100644 index 00000000000..bb99c274b07 --- /dev/null +++ b/docs/code/modules.rst @@ -0,0 +1,7 @@ +gamestonk_terminal +================== + +.. toctree:: + :maxdepth: 4 + + gamestonk_terminal diff --git a/docs/index.rst b/docs/index.rst index 72622f8c19d..bf31dfcf795 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,10 +7,10 @@ Welcome to Gamestonk Terminal's documentation! ============================================== .. toctree:: - :maxdepth: 2 + :maxdepth: 3 :caption: Contents: - code + code/gamestonk_terminal Indices and tables diff --git a/poetry.lock b/poetry.lock index eeecd4cd7bc..b67e0985ea8 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1358,6 +1358,26 @@ importlib-metadata = {version = "*", markers = "python_version < \"3.8\""} [package.extras] testing = ["coverage", "pyyaml"] +[[package]] +name = "markdown-it-py" +version = "1.1.0" +description = "Python port of markdown-it. Markdown parsing, done right!" +category = "dev" +optional = false +python-versions = "~=3.6" + +[package.dependencies] +attrs = ">=19,<22" +typing-extensions = {version = ">=3.7.4", markers = "python_version < \"3.8\""} + +[package.extras] +code_style = ["pre-commit (==2.6)"] +compare = ["commonmark (>=0.9.1,<0.10.0)", "markdown (>=3.2.2,<3.3.0)", "mistletoe-ebp (>=0.10.0,<0.11.0)", "mistune (>=0.8.4,<0.9.0)", "panflute (>=1.12,<2.0)"] +linkify = ["linkify-it-py (>=1.0,<2.0)"] +plugins = ["mdit-py-plugins"] +rtd = ["myst-nb (==0.13.0a1)", "pyyaml", "sphinx (>=2,<4)", "sphinx-copybutton", "sphinx-panels (>=0.4.0,<0.5.0)", "sphinx-book-theme"] +testing = ["coverage", "psutil", "pytest (>=3.6,<4)", "pytest-benchmark (>=3.2,<4.0)", "pytest-cov", "pytest-regressions"] + [[package]] name = "markupsafe" version = "2.0.1" @@ -1401,6 +1421,22 @@ category = "dev" optional = false python-versions = "*" +[[package]] +name = "mdit-py-plugins" +version = "0.2.8" +description = "Collection of plugins for markdown-it-py" +category = "dev" +optional = false +python-versions = "~=3.6" + +[package.dependencies] +markdown-it-py = ">=1.0,<2.0" + +[package.extras] +code_style = ["pre-commit (==2.6)"] +rtd = ["myst-parser (==0.14.0a3)", "sphinx-book-theme (>=0.1.0,<0.2.0)"] +testing = ["coverage", "pytest (>=3.6,<4)", "pytest-cov", "pytest-regressions"] + [[package]] name = "mistune" version = "0.8.4" @@ -1492,6 +1528,28 @@ category = "main" optional = false python-versions = "*" +[[package]] +name = "myst-parser" +version = "0.15.2" +description = "An extended commonmark compliant parser, with bridges to docutils & sphinx." +category = "dev" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +docutils = ">=0.15,<0.18" +jinja2 = "*" +markdown-it-py = ">=1.0.0,<2.0.0" +mdit-py-plugins = ">=0.2.8,<0.3.0" +pyyaml = "*" +sphinx = ">=3.1,<5" + +[package.extras] +code_style = ["pre-commit (>=2.12,<3.0)"] +linkify = ["linkify-it-py (>=1.0,<2.0)"] +rtd = ["ipython", "sphinx-book-theme (>=0.1.0,<0.2.0)", "sphinx-panels (>=0.5.2,<0.6.0)", "sphinxcontrib-bibtex (>=2.1,<3.0)", "sphinxext-rediraffe (>=0.2,<1.0)", "sphinxcontrib.mermaid (>=0.6.3,<0.7.0)", "sphinxext-opengraph (>=0.4.2,<0.5.0)"] +testing = ["beautifulsoup4", "coverage", "docutils (>=0.17.0,<0.18.0)", "pytest (>=3.6,<4)", "pytest-cov", "pytest-regressions"] + [[package]] name = "nbclassic" version = "0.3.4" @@ -1700,14 +1758,14 @@ scipy = ">=0.13.2" [[package]] name = "packaging" -version = "21.2" +version = "21.0" description = "Core utilities for Python packages" category = "main" optional = false python-versions = ">=3.6" [package.dependencies] -pyparsing = ">=2.0.2,<3" +pyparsing = ">=2.0.2" [[package]] name = "pandas" @@ -2172,11 +2230,14 @@ python-versions = "*" [[package]] name = "pyparsing" -version = "2.4.7" +version = "3.0.4" description = "Python parsing module" category = "main" optional = false -python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" +python-versions = ">=3.6" + +[package.extras] +diagrams = ["jinja2", "railroad-diagrams"] [[package]] name = "pyportfolioopt" @@ -3341,7 +3402,7 @@ prediction = ["tensorflow"] [metadata] lock-version = "1.1" python-versions = "^3.7" -content-hash = "8d774107f41538e1e6a35fa310519efcefe1fe763fe9f4d2acf8ee045af25297" +content-hash = "ccb7d0dc156b75f6168ba10f71db570f5e16832c98adaab3ad50f19db8e98520" [metadata.files] absl-py = [ @@ -4205,6 +4266,10 @@ markdown = [ {file = "Markdown-3.3.4-py3-none-any.whl", hash = "sha256:96c3ba1261de2f7547b46a00ea8463832c921d3f9d6aba3f255a6f71386db20c"}, {file = "Markdown-3.3.4.tar.gz", hash = "sha256:31b5b491868dcc87d6c24b7e3d19a0d730d59d3e46f4eea6430a321bed387a49"}, ] +markdown-it-py = [ + {file = "markdown-it-py-1.1.0.tar.gz", hash = "sha256:36be6bb3ad987bfdb839f5ba78ddf094552ca38ccbd784ae4f74a4e1419fc6e3"}, + {file = "markdown_it_py-1.1.0-py3-none-any.whl", hash = "sha256:98080fc0bc34c4f2bcf0846a096a9429acbd9d5d8e67ed34026c03c61c464389"}, +] markupsafe = [ {file = "MarkupSafe-2.0.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:d8446c54dc28c01e5a2dbac5a25f071f6653e6e40f3a8818e8b45d790fe6ef53"}, {file = "MarkupSafe-2.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:36bc903cbb393720fad60fc28c10de6acf10dc6cc883f3e24ee4012371399a38"}, @@ -4307,6 +4372,10 @@ mccabe = [ {file = "mccabe-0.6.1-py2.py3-none-any.whl", hash = "sha256:ab8a6258860da4b6677da4bd2fe5dc2c659cff31b3ee4f7f5d64e79735b80d42"}, {file = "mccabe-0.6.1.tar.gz", hash = "sha256:dd8d182285a0fe56bace7f45b5e7d1a6ebcbf524e8f3bd87eb0f125271b8831f"}, ] +mdit-py-plugins = [ + {file = "mdit-py-plugins-0.2.8.tar.gz", hash = "sha256:5991cef645502e80a5388ec4fc20885d2313d4871e8b8e320ca2de14ac0c015f"}, + {file = "mdit_py_plugins-0.2.8-py3-none-any.whl", hash = "sha256:1833bf738e038e35d89cb3a07eb0d227ed647ce7dd357579b65343740c6d249c"}, +] mistune = [ {file = "mistune-0.8.4-py2.py3-none-any.whl", hash = "sha256:88a1051873018da288eee8538d476dffe1262495144b33ecb586c4ab266bb8d4"}, {file = "mistune-0.8.4.tar.gz", hash = "sha256:59a3429db53c50b5c6bcc8a07f8848cb00d7dc8bdb431a4ab41920d201d4756e"}, @@ -4459,6 +4528,10 @@ mypy-extensions = [ {file = "mypy_extensions-0.4.3-py2.py3-none-any.whl", hash = "sha256:090fedd75945a69ae91ce1303b5824f428daf5a028d2f6ab8a299250a846f15d"}, {file = "mypy_extensions-0.4.3.tar.gz", hash = "sha256:2d82818f5bb3e369420cb3c4060a7970edba416647068eb4c5343488a6c604a8"}, ] +myst-parser = [ + {file = "myst-parser-0.15.2.tar.gz", hash = "sha256:f7f3b2d62db7655cde658eb5d62b2ec2a4631308137bd8d10f296a40d57bbbeb"}, + {file = "myst_parser-0.15.2-py3-none-any.whl", hash = "sha256:40124b6f27a4c42ac7f06b385e23a9dcd03d84801e9c7130b59b3729a554b1f9"}, +] nbclassic = [ {file = "nbclassic-0.3.4-py3-none-any.whl", hash = "sha256:9c7b7987a148ecdd1827b47fe6f6968b2ddabf663142f81254000cb77ee5bd10"}, {file = "nbclassic-0.3.4.tar.gz", hash = "sha256:f00b07ef4908fc38fd332d2676ccd3ceea5076528feaf21bd27e809ef20f5578"}, @@ -4586,8 +4659,8 @@ osqp = [ {file = "osqp-0.6.2.post0.tar.gz", hash = "sha256:5f0695f26a3bef0fae91254bc283fab790dcca0064bfe0f425167f9c9e8b4cbc"}, ] packaging = [ - {file = "packaging-21.2-py3-none-any.whl", hash = "sha256:14317396d1e8cdb122989b916fa2c7e9ca8e2be9e8060a6eff75b6b7b4d8a7e0"}, - {file = "packaging-21.2.tar.gz", hash = "sha256:096d689d78ca690e4cd8a89568ba06d07ca097e3306a4381635073ca91479966"}, + {file = "packaging-21.0-py3-none-any.whl", hash = "sha256:c86254f9220d55e31cc94d69bade760f0847da8000def4dfe1c6b872fd14ff14"}, + {file = "packaging-21.0.tar.gz", hash = "sha256:7dc96269f53a4ccec5c0670940a4281106dd0bb343f47b7471f779df49c2fbe7"}, ] pandas = [ {file = "pandas-1.1.5-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:bf23a3b54d128b50f4f9d4675b3c1857a688cc6731a32f931837d72effb2698d"}, @@ -4871,8 +4944,8 @@ pyotp = [ {file = "pyotp-2.6.0.tar.gz", hash = "sha256:d28ddfd40e0c1b6a6b9da961c7d47a10261fb58f378cb00f05ce88b26df9c432"}, ] pyparsing = [ - {file = "pyparsing-2.4.7-py2.py3-none-any.whl", hash = "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b"}, - {file = "pyparsing-2.4.7.tar.gz", hash = "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1"}, + {file = "pyparsing-3.0.4-py3-none-any.whl", hash = "sha256:c0a7dfcd26825bd4453574c4e7ad04aa095975ce54d04f738fe3a8350fbd223a"}, + {file = "pyparsing-3.0.4.tar.gz", hash = "sha256:e0df773d7fa2240322daae7805626dfc5f2d5effb34e1a7be2702c99cfb9f6b1"}, ] pyportfolioopt = [ {file = "PyPortfolioOpt-1.5.1-py3-none-any.whl", hash = "sha256:11c2eb7e3a9e74ee04b28be0a05acb0cfab134668c477a1590f1dfae1a7c24b0"}, diff --git a/pyproject.toml b/pyproject.toml index 5b719132b03..357b4756c5b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -92,7 +92,8 @@ mypy = "^0.901" mock = "^4.0.3" codespell = "^2.0.0" pyupgrade = "^2.11.0" -Sphinx = "4.1.1" +sphinx = "4.1.1" +myst-parser = "^0.15.2" black = "21.7b0" [tool.poetry.extras] diff --git a/requirements-full.txt b/requirements-full.txt index 342ebf0e673..5d6b25ce061 100644 --- a/requirements-full.txt +++ b/requirements-full.txt @@ -9,9 +9,11 @@ appdirs==1.4.4; python_full_version >= "3.6.2" and python_version >= "3.6" appnope==0.1.2; platform_system == "Darwin" and python_version >= "3.7" and sys_platform == "darwin" argcomplete==1.12.3; python_version < "3.8.0" and python_version >= "3.7" argon2-cffi==21.1.0; python_version >= "3.6" +astroid==2.7.3; python_version >= "3.6" and python_version < "4.0" astunparse==1.6.3 async-timeout==3.0.1; python_full_version >= "3.5.3" and python_version >= "3.6" -attrs==21.2.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6" +atomicwrites==1.4.0; python_version >= "3.6" and python_full_version < "3.0.0" and sys_platform == "win32" or sys_platform == "win32" and python_version >= "3.6" and python_full_version >= "3.4.0" +attrs==21.2.0; python_version >= "3.6" and python_full_version < "3.0.0" and python_version < "4.0" or python_full_version >= "3.5.0" and python_version >= "3.6" and python_version < "4.0" babel==2.9.1; python_full_version >= "3.6.8" and python_full_version < "4.0.0" and python_version >= "3.6" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6") backcall==0.2.0; python_version >= "3.7" backports.zoneinfo==0.2.1; python_version < "3.9" and python_version >= "3.6" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3.6") @@ -28,6 +30,7 @@ chardet==3.0.4; python_version >= "3.6" charset-normalizer==2.0.1; python_full_version >= "3.5.0" clang==5.0 click==8.0.3; python_full_version >= "3.6.2" and python_version >= "3.6" +codespell==2.1.0; python_version >= "3.5" colorama==0.4.4; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.5.0") convertdate==2.3.2; python_version >= "3.6" coverage==5.5; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.5.0" and python_version < "4") @@ -44,7 +47,7 @@ defusedxml==0.7.1; python_version >= "3.7" and python_full_version < "3.0.0" or degiro-connector==1.0.0; python_version >= "3.6" deprecation==2.1.0 detecta==0.0.5; python_version >= "3.6" -docutils==0.16; python_full_version >= "3.6.8" and python_full_version < "4.0.0" and python_version >= "3.6" +docutils==0.16; python_full_version >= "3.6.8" and python_full_version < "4.0.0" and python_version >= "3.6" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6") ecos==2.0.7.post1; python_full_version >= "3.6.1" and python_full_version < "4.0.0" and python_version >= "3.5" entrypoints==0.3; python_version >= "3.7" et-xmlfile==1.1.0; python_version >= "3.6" @@ -53,6 +56,7 @@ ffn==0.3.6; python_version >= "2.7" and python_full_version < "3.0.0" or python_ financedatabase==1.0.0 finviz==1.4.2 finvizfinance==0.9.10; python_version >= "3.5" +flake8==3.9.2; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.5.0") flatbuffers==1.12 fred==3.1 fredapi==0.4.3 @@ -71,13 +75,15 @@ hijri-converter==2.2.2; python_version >= "3.6" holidays==0.11.3.1; python_version >= "3.6" idna==3.3; python_full_version >= "3.6.2" and python_version >= "3.6" imagesize==1.2.0; python_full_version >= "3.6.8" and python_full_version < "4.0.0" and python_version >= "3.6" -importlib-metadata==4.8.1; python_version == "3.7" +importlib-metadata==4.8.1; python_version == "3.7" and (python_version >= "3.6" and python_full_version < "3.0.0" and python_version < "3.8" or python_full_version >= "3.5.0" and python_version < "3.8" and python_version >= "3.6") inflection==0.5.1; python_version >= "3.5" +iniconfig==1.1.1; python_version >= "3.6" ipykernel==6.4.2; python_version >= "3.7" ipython-genutils==0.2.0; python_version >= "3.7" ipython==7.29.0; python_version >= "3.7" ipywidgets==7.6.5 iso8601==0.1.16 +isort==5.9.3; python_full_version >= "3.6.1" and python_version < "4.0" and python_version >= "3.6" jedi==0.18.0; python_version >= "3.7" jinja2==3.0.2; python_full_version >= "3.6.8" and python_full_version < "4.0.0" and python_version >= "3.7" joblib==1.1.0; python_version >= "3.7" @@ -96,13 +102,18 @@ keras-preprocessing==1.1.2 keras==2.6.0 kiwisolver==1.3.2; python_version >= "3.7" korean-lunar-calendar==0.2.1; python_version >= "3.6" +lazy-object-proxy==1.6.0; python_version >= "3.6" and python_full_version < "3.0.0" and python_version < "4.0" or python_version >= "3.6" and python_version < "4.0" and python_full_version >= "3.6.0" lxml==4.6.3; python_full_version >= "3.6.8" and python_version >= "3.5" and python_full_version < "4.0.0" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3.6") m2r2==0.2.8; python_full_version >= "3.6.8" and python_full_version < "4.0.0" +markdown-it-py==1.1.0; python_version >= "3.6" and python_version < "4.0" markdown==3.3.4; python_version >= "3.6" markupsafe==2.0.1; python_version >= "3.6" matplotlib-inline==0.1.3; python_version >= "3.7" matplotlib==3.4.3; python_version >= "3.7" +mccabe==0.6.1; python_version >= "3.6" and python_version < "4.0" and (python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0") +mdit-py-plugins==0.2.8; python_version >= "3.6" and python_version < "4.0" mistune==0.8.4; python_full_version >= "3.6.8" and python_full_version < "4.0.0" and python_version >= "3.7" +mock==4.0.3; python_version >= "3.6" more-itertools==8.10.0; python_version >= "3.5" mplfinance==0.12.7a17 msgpack==1.0.2 @@ -110,6 +121,7 @@ multidict==5.2.0; python_version >= "3.6" multitasking==0.0.9 mypy-extensions==0.4.3; python_full_version >= "3.6.2" and python_version >= "3.6" mypy==0.901; python_version >= "3.5" +myst-parser==0.15.2; python_version >= "3.6" nbclassic==0.3.4; python_version >= "3.6" nbclient==0.5.4; python_full_version >= "3.6.1" and python_version >= "3.7" nbconvert==6.2.0; python_version >= "3.7" @@ -124,7 +136,7 @@ openpyxl==3.0.7; python_version >= "3.6" opt-einsum==3.3.0; python_version >= "3.5" orjson==3.6.4; python_version >= "3.7" osqp==0.6.2.post0; python_full_version >= "3.6.1" and python_full_version < "4.0.0" and python_version >= "3.5" -packaging==21.2; python_full_version >= "3.6.8" and python_full_version < "4.0.0" and python_version >= "3.7" +packaging==21.0; python_full_version >= "3.6.8" and python_full_version < "4.0.0" and python_version >= "3.7" pandas-datareader==0.10.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3.6" pandas-ta==0.2.45b pandas==1.1.5; python_full_version >= "3.6.1" @@ -136,7 +148,9 @@ patsy==0.5.2; python_version >= "3.6" pexpect==4.8.0; sys_platform != "win32" and python_version >= "3.7" pickleshare==0.7.5; python_version >= "3.7" pillow==8.4.0; python_version >= "3.6" +platformdirs==2.4.0; python_version >= "3.6" and python_version < "4.0" plotly==4.14.3 +pluggy==1.0.0; python_version >= "3.6" pmdarima==1.8.3; python_version >= "3.6" praw==7.4.0; python_version >= "3.6" and python_version < "4.0" prawcore==2.3.0; python_version >= "3.6" and python_version < "4.0" @@ -146,22 +160,26 @@ prompt-toolkit==3.0.21; python_full_version >= "3.6.2" protobuf==3.19.1; python_version >= "3.6" psaw==0.0.12; python_version >= "3" ptyprocess==0.7.0; os_name != "nt" and python_version >= "3.7" and sys_platform != "win32" -py==1.10.0; python_version >= "3.6" and python_full_version < "3.0.0" and implementation_name == "pypy" or implementation_name == "pypy" and python_version >= "3.6" and python_full_version >= "3.4.0" +py==1.10.0; python_version >= "3.6" and python_full_version < "3.0.0" and implementation_name == "pypy" or python_full_version >= "3.4.0" and python_version >= "3.6" and implementation_name == "pypy" pyally==1.1.2 pyasn1-modules==0.2.8; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3.6" pyasn1==0.4.8; python_version >= "3.6" and python_full_version < "3.0.0" and python_version < "4" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3.6") or python_full_version >= "3.6.0" and python_version >= "3.6" and python_version < "4" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3.6") +pycodestyle==2.7.0; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" pycoingecko==1.4.1 pycparser==2.20; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6" pyex==0.5.0 +pyflakes==2.3.1; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" pygments==2.10.0; python_full_version >= "3.6.8" and python_full_version < "4.0.0" and python_version >= "3.7" +pylint==2.10.2; python_version >= "3.6" and python_version < "4.0" pymeeus==0.5.11; python_version >= "3.6" pyobjc-core==7.3; python_version >= "3.6" and sys_platform == "darwin" pyobjc-framework-cocoa==7.3; python_version >= "3.6" and sys_platform == "darwin" pyotp==2.6.0; python_version >= "3" -pyparsing==2.4.7; python_version >= "3.7" and python_full_version < "3.0.0" or python_full_version >= "3.3.0" and python_version >= "3.7" +pyparsing==3.0.4; python_version >= "3.7" pyportfolioopt==1.5.1; python_full_version >= "3.6.1" and python_full_version < "4.0.0" pyprind==2.11.3; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" pyrsistent==0.14.11 +pytest==6.2.5; python_version >= "3.6" python-binance==1.0.15 python-coinmarketcap==0.2 python-dateutil==2.8.2; python_full_version >= "3.6.1" and python_version >= "3.6" and (python_version >= "3.7" and python_full_version < "3.0.0" or python_full_version >= "3.3.0" and python_version >= "3.7") and (python_version >= "3.5" and python_full_version < "3.0.0" or python_full_version >= "3.3.0" and python_version >= "3.5") and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.3.0" and python_version >= "3.6") @@ -228,13 +246,13 @@ thepassiveinvestor==1.0.9 threadpoolctl==3.0.0; python_version >= "3.7" timeseries-cv==0.1.4; python_version >= "3.6" and python_version < "4.0" tokenize-rt==4.2.1; python_full_version >= "3.6.1" -toml==0.10.2; python_version >= "3.5" and python_full_version < "3.0.0" or python_full_version >= "3.3.0" and python_version >= "3.5" +toml==0.10.2; python_version >= "3.6" and python_full_version < "3.0.0" and python_version < "4.0" or python_full_version >= "3.3.0" and python_version >= "3.6" and python_version < "4.0" tomli==1.2.2; python_full_version >= "3.6.2" and python_version >= "3.6" tornado==6.1; python_full_version >= "3.6.1" and python_version >= "3.7" tqdm==4.62.3; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6" tradingview-ta==3.2.9; python_version >= "3.6" traitlets==5.1.1; python_full_version >= "3.6.1" and python_version >= "3.7" -typed-ast==1.4.3; python_version < "3.8" and python_version >= "3.6" and python_full_version >= "3.6.2" +typed-ast==1.4.3; python_version < "3.8" and python_version >= "3.6" and python_full_version >= "3.6.2" and implementation_name == "cpython" typing-extensions==3.7.4.3; python_version < "3.8" and python_version >= "3.7" and python_full_version >= "3.6.2" tzdata==2021.5; platform_system == "Windows" and python_version >= "3.6" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3.6") tzlocal==4.1; python_version >= "3.6" @@ -251,7 +269,7 @@ websocket-client==1.2.1; python_version >= "3.6" and python_version < "4.0" websockets==9.1; python_full_version >= "3.6.1" werkzeug==2.0.2; python_version >= "3.6" widgetsnbextension==3.5.2 -wrapt==1.12.1; python_version >= "3.6" +wrapt==1.12.1; python_version >= "3.6" and python_version < "4.0" yarl==1.7.0; python_version >= "3.6" yfinance==0.1.64 zipp==3.6.0; python_version < "3.8" and python_version >= "3.6" diff --git a/requirements.txt b/requirements.txt index 683ce1f3c30..a8cef9154e9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -109,7 +109,7 @@ onetimepass==1.0.1; python_version >= "3.6" openpyxl==3.0.7; python_version >= "3.6" orjson==3.6.4; python_version >= "3.7" osqp==0.6.2.post0; python_full_version >= "3.6.1" and python_full_version < "4.0.0" and python_version >= "3.5" -packaging==21.2; python_full_version >= "3.6.8" and python_full_version < "4.0.0" and python_version >= "3.7" +packaging==21.0; python_full_version >= "3.6.8" and python_full_version < "4.0.0" and python_version >= "3.7" pandas-datareader==0.10.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3.6" pandas-ta==0.2.45b pandas==1.1.5; python_full_version >= "3.6.1" @@ -141,7 +141,7 @@ pymeeus==0.5.11; python_version >= "3.6" pyobjc-core==7.3; python_version >= "3.6" and sys_platform == "darwin" pyobjc-framework-cocoa==7.3; python_version >= "3.6" and sys_platform == "darwin" pyotp==2.6.0; python_version >= "3" -pyparsing==2.4.7; python_version >= "3.7" and python_full_version < "3.0.0" or python_full_version >= "3.3.0" and python_version >= "3.7" +pyparsing==3.0.4; python_version >= "3.7" pyportfolioopt==1.5.1; python_full_version >= "3.6.1" and python_full_version < "4.0.0" pyprind==2.11.3; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" pyrsistent==0.14.11