install v4 (#5766)

* install v4

* add run on pr

* this seems sus

* thnx juan

* flip

* thnx juan

* idk

* Update index.js

* Update Root.tsx

* Update index.js

* try again

* fix front matter

* fix description front matter

* Revert "fix description front matter"

This reverts commit cccc7b2469.

* try to fix this mickey

* fixed all that mickey @DidierRLopes broke

* Update index.js

* generate platform fix

* black fix

---------

Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: tehcoderer <me@tehcoderer.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
This commit is contained in:
James Maslek
2023-11-21 01:38:50 -05:00
committed by GitHub
parent c680a74872
commit dce447b423
61 changed files with 1018 additions and 64 deletions

View File

@@ -6,9 +6,11 @@ on:
- main
- release/*
pull_request:
types: [closed]
branches:
- develop
pull_request:
types: [opened, synchronize, reopened]
branches:
- develop
- 'docs/*'
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
@@ -64,7 +66,12 @@ jobs:
source $VENV
pip uninstall Brotli -y
pytest tests/website --autodoc
python website/generate_platform_v4_markdown.py && website/generate_sdk_v3_markdown.py && python website/generate_terminal_v3_markdown.py
python website/generate_sdk_v3_markdown.py
python website/generate_terminal_v3_markdown.py
pip install -U poetry
python openbb_platform/dev_install.py -e all
pip uninstall nbmake -y
python website/generate_platform_v4_markdown.py
- name: Setup Node
uses: actions/setup-node@v3

View File

@@ -1,9 +1,9 @@
---
title: chains
description: "This docusaurus page explores the 'chains' command which allows users\
\ to view Options Chains by Expiry for a specific stock. It also explains several\
\ parameters such as Stock Ticker, Expiration Date, type of options \u2013 Calls\
\ or Puts, and Strike Prices."
description: This docusaurus page explores the `chains` command which allows users
to view Options Chains by Expiry for a specific stock. It also explains several
parameters such as Stock Ticker, Expiration Date, type of options Calls
or Puts, and Strike Prices.
keywords:
- Options Chains by Expiry
- Stock Ticker

View File

@@ -1,8 +1,8 @@
---
title: pm
description: "Our tool offers the ability to view the top pre-market gainers, losers,\
\ and most active. This page will guide you on how to use the pm command to have\
\ a better understanding of the market\u2019s movements before it officially opens."
description: Our tool offers the ability to view the top pre-market gainers, losers,
and most active. This page will guide you on how to use the pm command to have
a better understanding of the market's movements before it officially opens.
keywords:
- Pre-Market Top Gainers
- Pre-Market Top Losers

View File

@@ -1,9 +1,9 @@
---
title: wk
description: "This page provides the documentation of 'flowsum wk' command. It explains\
\ how to retrieve the top flow per week for Calls and Puts by stock for understanding\
\ the market\u2019s sentiment towards a certain stock. Parameters and usage are\
\ clearly detailed."
description: This page provides the documentation of `flowsum wk` command. It explains
how to retrieve the top flow per week for Calls and Puts by stock for understanding
the market's sentiment towards a certain stock. Parameters and usage are
clearly detailed.
keywords:
- flowsum wk
- stock market sentiment

View File

@@ -42,4 +42,4 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
6. Collaboration:
- Engage actively with the OpenBB development team to ensure that your contributions align with the platform's roadmap and standards.
- Welcome feedback and be open to making revisions based on reviews and suggestions from the community.
- Welcome feedback and be open to making revisions based on reviews and suggestions from the community.

View File

@@ -2,7 +2,7 @@
title: moody
description: Explore and analyze the Moody Corporate Bond Index and Moody's Aaa and
Baa investment bonds. Find the performance, rating, and interest rate information.
Use the `moody()` function in Python to retrieve the data with customizable parameters.
Use the ``moody()`` function in Python to retrieve the data with customizable parameters.
keywords:
- Moody Corporate Bond Index
- Moody's Aaa
@@ -113,4 +113,3 @@ OBBject
</TabItem>
</Tabs>

View File

@@ -136,4 +136,3 @@ OBBject
</TabItem>
</Tabs>

View File

@@ -55,4 +55,3 @@ This function does not take standardized parameters.
This function does not return a standardized model
---

View File

@@ -1,15 +1,15 @@
---
title: estr
description: "Learn about the euro short-term rate (\u20ACSTR), wholesale euro unsecured\
\ overnight borrowing costs, TARGET2 business day transactions, parameters for the\
\ Python obb.fixedincome.rate.estr method, and the data and returns provided."
description: Learn about the euro short-term rate ($ACSTR), wholesale euro unsecured
overnight borrowing costs, TARGET2 business day transactions, parameters for the
Python obb.fixedincome.rate.estr method, and the data and returns provided.
keywords:
- euro short-term rate
- "\u20ACSTR"
- $ACSTR
- wholesale euro unsecured overnight borrowing costs
- TARGET2 business day
- transactions
- "arm\u2019s length"
- arm's length
- market rates
- Python obb.fixedincome.rate.estr
- parameters

View File

@@ -1,6 +1,6 @@
---
title: symbol_map
description: Retrieve the ticker symbol corresponding to a company's CIK using the
description: Retrieve the ticker symbol corresponding to a company CIK using the
OBB API endpoint. This function allows you to perform a search query and get the
results along with additional metadata, warnings, and optional chart data.
keywords:
@@ -88,4 +88,3 @@ OBBject
</TabItem>
</Tabs>

View File

@@ -1,9 +1,7 @@
---
title: Overview
sidebar_position: 1
description: An overview for getting started with the OpenBB Platform's Python client and Fast API; details
on authorization, data providers, settings, responses, commands, logging, and features
such as dynamic command execution.
description: An overview for getting started with the OpenBB Platform Python client and Fast API, details on authorization, data providers, settings, responses, commands, logging, and features such as dynamic command execution.
keywords:
- OpenBB Platform
- Python client

View File

@@ -0,0 +1,25 @@
---
title: Economic Calendar
description: Economic events from the global economy
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Economic Calendar
- economy
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Economic Calendar - economy | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/economy/economic_calendar.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Economic events from the global economy.
Source: tradingeconomics

View File

@@ -0,0 +1,25 @@
---
title: Analyst Estimates
description: Analyst Estimates for a certain ticker Quarterly and Annual
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Analyst Estimates
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Analyst Estimates - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/analyst_estimates.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Analyst Estimates for a certain ticker Quarterly and Annual.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Price Target By Analyst
description: Analyst Price Targets for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Price Target By Analyst
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Price Target By Analyst - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/analyst_price_target.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Analyst Price Targets for a certain ticker.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Analyst Upgrades and Downgrades
description: Analyst Upgrades and Downgrades for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Analyst Upgrades and Downgrades
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Analyst Upgrades and Downgrades - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/analyst_upgrades_downgrades.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Analyst Upgrades and Downgrades for a certain ticker.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Balance Sheet
description: Balance Sheet for a certain ticker Quarterly and Annual
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Balance Sheet
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Balance Sheet - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/balance_sheet.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Balance Sheet for a certain ticker Quarterly and Annual.
Source: intrinio

View File

@@ -0,0 +1,25 @@
---
title: Cash Flow Statement
description: Cash Flow Statement for a certain ticker Quarterly and Annual
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Cash Flow Statement
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Cash Flow Statement - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/cash_flow_statement.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Cash Flow Statement for a certain ticker Quarterly and Annual.
Source: intrinio

View File

@@ -0,0 +1,25 @@
---
title: Charting
description: Show charting
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Charting
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Charting - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/charting.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Show charting.
Source: fmp,intrinio,fred

View File

@@ -0,0 +1,25 @@
---
title: Earnings History
description: Earnings History for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Earnings History
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Earnings History - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/company_events.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Earnings History for a certain ticker.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Company News
description: Show company news for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Company News
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Company News - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/company_news.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Show company news for a certain ticker.
Source: benzinga

View File

@@ -0,0 +1,25 @@
---
title: Company profile
description: Show company profile for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Company profile
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Company profile - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/company_profile.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Show company profile for a certain ticker.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Earnings Transcripts
description: Full transcript of earnings call
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Earnings Transcripts
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Earnings Transcripts - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/earnings_transcripts.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Full transcript of earnings call.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Ticker Information
description: Ticker Information
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Ticker Information
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Ticker Information - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/equity_select.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Ticker Information.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Financial Ratios
description: Show financial ratios for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Financial Ratios
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Financial Ratios - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/financial_ratios.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Show financial ratios for a certain ticker.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Financial Statements
description: Balance sheet, Income Statement, Cashflow Statement
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Financial Statements
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Financial Statements - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/financial_statements.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Balance sheet, Income Statement, Cashflow Statement.
Source: intrinio

View File

@@ -0,0 +1,25 @@
---
title: Global News
description: Show news from around the world
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Global News
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Global News - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/global_news.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Show news from around the world.
Source: benzinga

View File

@@ -0,0 +1,25 @@
---
title: Comparison Analysis
description: Compare multiple tickers
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Comparison Analysis
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Comparison Analysis - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/grouped_comparison.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Compare multiple tickers.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Income Statement
description: Income Statement for a certain ticker Quarterly and Annual
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Income Statement
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Income Statement - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/income_statement.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Income Statement for a certain ticker Quarterly and Annual.
Source: intrinio

View File

@@ -0,0 +1,25 @@
---
title: Insider Trading
description: Recent Insider Trading
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Insider Trading
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Insider Trading - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/insider_trading.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Recent Insider Trading.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Institutional Ownership
description: Instutional Ownership quarterly
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Institutional Ownership
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Institutional Ownership - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/institutional_ownership.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Instutional Ownership quarterly.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Key Metrics
description: Key Metrics for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Key Metrics
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Key Metrics - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/key_metrics.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Key Metrics for a certain ticker.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Management Team
description: Management Team for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Management Team
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Management Team - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/management_team.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Management Team for a certain ticker.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Market Indices
description: Show market overview (SP500, Nasdaq, Gold, ...)
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Market Indices
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Market Indices - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/market_overview.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Show market overview (SP500, Nasdaq, Gold, ...).
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Price performance
description: Show price performance for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Price performance
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Price performance - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/price_performance.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Show price performance for a certain ticker.
Source: intrinio

View File

@@ -0,0 +1,25 @@
---
title: Price Target
description: Price Targets for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Price Target
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Price Target - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/price_target.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Price Targets for a certain ticker.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Revenue Per Business Line
description: Revenue Per Business Line Quarterly and Annual
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Revenue Per Business Line
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Revenue Per Business Line - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/revenue_per_bus_line.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Revenue Per Business Line Quarterly and Annual.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Revenue Per Geography
description: Revenue Per Geography Quarterly and Annual
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Revenue Per Geography
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Revenue Per Geography - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/revenue_per_geography.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Revenue Per Geography Quarterly and Annual.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: SEC Filings
description: Recent SEC Filings for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- SEC Filings
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="SEC Filings - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/sec_filings.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Recent SEC Filings for a certain ticker.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Share Statistics
description: Show share statistics for a certain ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Share Statistics
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Share Statistics - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/share_statistics.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Show share statistics for a certain ticker.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Dividend Payment
description: History of stock dividends
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Dividend Payment
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Dividend Payment - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/stock_dividends.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
History of stock dividends.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Stock Ownership
description: Instutional Ownership by percentage for a ticker
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Stock Ownership
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Stock Ownership - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/stock_ownership.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Instutional Ownership by percentage for a ticker.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Stock Splits
description: History of stock splits
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Stock Splits
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Stock Splits - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/stock_splits.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
History of stock splits.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Valuation Multiples
description: Vaulation Multiples Annually and Quarterly
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Valuation Multiples
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Valuation Multiples - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/valuation_multiples.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Vaulation Multiples Annually and Quarterly.
Source: fmp

View File

@@ -0,0 +1,25 @@
---
title: Watchlist
description: Show watchlist for one or more tickers
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Watchlist
- equity
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Watchlist - equity | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/equity/watchlist.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Show watchlist for one or more tickers.
Source: fmp,intrinio

View File

@@ -0,0 +1,25 @@
---
title: Navigation Bar
description: Create inner tabs inside a tab
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Navigation Bar
- ui
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Navigation Bar - ui | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/ui/navigation_bar.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Create inner tabs inside a tab.

View File

@@ -0,0 +1,22 @@
---
title: Clock
description: Show a clock
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Clock
- utilities
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Clock - utilities | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/utilities/clock.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Show a clock.

View File

@@ -0,0 +1,22 @@
---
title: External Table
description: Show a table loaded from external source
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- External Table
- utilities
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="External Table - utilities | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/utilities/external_table.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Show a table loaded from external source.

View File

@@ -0,0 +1,22 @@
---
title: Text Widget
description: Create a text widget
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- Text Widget
- utilities
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Text Widget - utilities | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/utilities/rich_note.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
Create a text widget.

View File

@@ -0,0 +1,22 @@
---
title: RSS Viewer
description: View RSS feeds
keywords:
- OpenBB
- Terminal Pro
- Investment Research
- Widgets
- RSS Viewer
- utilities
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="RSS Viewer - utilities | OpenBB Terminal Pro Docs" />
<img
src="https://raw.githubusercontent.com/OpenBB-finance/widgets-library/main/utilities/rss_viewer.png"
alt="OpenBB Terminal Pro Widgets Library"
/>
View RSS feeds.

View File

@@ -1,7 +1,7 @@
---
title: Chat with widgets
sidebar_position: 0
description: Learn about OpenBB Terminal Pro's innovative feature, the Chat Widget.
description: Learn about OpenBB Terminal Pro innovative feature, the Chat Widget.
This generative AI tool enhances efficiency and productivity in investment research
by offering direct data interaction.
keywords:

View File

@@ -2,7 +2,7 @@
title: Discovery
sidebar_position: 2
description: This page provides detailed instructions on how to use the Discovery
sub-module within the 'openbb.crypto.disc' to find new trends in Crypto markets.
sub-module within the ''openbb.crypto.disc'' to find new trends in Crypto markets.
The module enables users to search coins on CoinGecko by category, access a list
of coins available on CoinGecko, search CoinPaprika, view top coins, DeFi applications,
NFTs, and games by daily volume and users, and more. It also provides examples in

View File

@@ -1,10 +1,10 @@
---
title: Government
description: "The page provides comprehensive information about the Government module\u2014\
that offers programmatic access to OpenBB Terminal functions. It includes details\
\ about commands available, how to use them with Python, and examples. It serves\
\ as a vital resource for those interested in examining US government data related\
\ to publicly traded companies."
description: The page provides comprehensive information about the Government module
that offers programmatic access to OpenBB Terminal functions. It includes details
about commands available, how to use them with Python, and examples. It serves
as a vital resource for those interested in examining US government data related
to publicly traded companies.
keywords:
- Government module
- programmatic access

View File

@@ -1,6 +1,6 @@
---
title: sreturn
description: "Get terra blockchain staking returns history"
description: Get terra blockchain staking returns history
keywords:
- blockchain
- terra

View File

@@ -1,8 +1,8 @@
---
title: platforms
description: "This page contains a directory of all smart contract platforms such\
\ as Ethereum, Solana, Cosmos, Polkadot, and Kusama. The page provides source codes\
\ and instructs the use of functionalities in two formats \u2014 model and chart."
description: This page contains a directory of all smart contract platforms such
as Ethereum, Solana, Cosmos, Polkadot, and Kusama. The page provides source codes
and instructs the use of functionalities in two formats model and chart.
keywords:
- smart contract platforms
- Ethereum

View File

@@ -1,8 +1,8 @@
---
title: balance
description: "This page provides a detailed view on the balance data obtained through\
\ OpenBB Terminal\u2019s stocks comparison analysis. Python source code, parameters\
\ for the function and return type are conventionally presented."
description: This page provides a detailed view on the balance data obtained through
OpenBB Terminal's stocks comparison analysis. Python source code, parameters
for the function and return type are conventionally presented.
keywords:
- balance data
- stocks comparison analysis

View File

@@ -1,8 +1,8 @@
---
title: mktcap
description: "This page provides documentation about the mktcap function of OpenBB-finance\u2019\
s Yahoo Finance Module. It explains the operation and usage of the functions for\
\ market cap modeling and charting over a certain period."
description: This page provides documentation about the mktcap function of OpenBB-finance's
Yahoo Finance Module. It explains the operation and usage of the functions for
market cap modeling and charting over a certain period.
keywords:
- OpenBB-finance
- Yahoo Finance

View File

@@ -1,9 +1,9 @@
---
title: gh
description: "Learn how to utilize the GH command line tool to track GitHub activity\
\ for a given crypto coin. Discover how to filter by development activity, set frequency\
\ intervals, and define start and end dates\u2014all with this powerful Python-based\
\ tool."
description: Learn how to utilize the GH command line tool to track GitHub activity
for a given crypto coin. Discover how to filter by development activity, set frequency
intervals, and define start and end dates with this powerful Python-based
tool.
keywords:
- Github activity
- Pull Request

View File

@@ -1,11 +1,11 @@
---
title: lowfloat
description: "The LowFloat webpage provides sophisticated tools for retrieving information\
\ about top stocks with the lowest float. It offers a comprehensive database that\
\ includes stocks from Nasdaq, the New York Stock Exchange, the American Stock Exchange,\
\ and the Over the Counter Bulletin Board. The service not only provides a stock\u2019\
s float, but also provides additional key data such as the number of outstanding\
\ shares, short interest, and company industry."
description: The LowFloat webpage provides sophisticated tools for retrieving information
about top stocks with the lowest float. It offers a comprehensive database that
includes stocks from Nasdaq, the New York Stock Exchange, the American Stock Exchange,
and the Over the Counter Bulletin Board. The service not only provides a stock's
float, but also provides additional key data such as the number of outstanding
shares, short interest, and company industry.
keywords:
- lowfloat
- stocks

View File

@@ -490,15 +490,17 @@ def generate_platform_markdown() -> None:
filepath = content_path / folder / f"{func_name}.md"
markdown = generate_markdown(meta_command=meta_command)
if data_model := meta_command.get("model", None):
## title is the desc here - clean this later
(
data_model_card_title,
data_model_card_description,
) = generate_data_model_card_info(meta_command)
data_markdown = (
f"---\ntitle: {data_model_card_title}\n"
"description: OpenBB Platform Data Model\n---\n\n"
f"---\ntitle: {data_model}\n"
f"description: {data_model_card_title}\n---\n\n"
"<!-- markdownlint-disable MD012 MD031 MD033 -->\n\n"
"import Tabs from '@theme/Tabs';\nimport TabItem from '@theme/TabItem';\n\n"
)
@@ -519,8 +521,8 @@ def generate_platform_markdown() -> None:
data_reference_cards.setdefault(data_filepath.parent, []).append(
dict(
title=data_model_card_title,
description=data_model_card_description or "",
title=data_model,
description=data_model_card_title or "",
url=data_models_path.relative_to(data_models_path) / data_model,
)
)

View File

@@ -1,6 +1,7 @@
import Link from "@docusaurus/Link";
import { useLocation } from "@docusaurus/router";
import LetteringDocsLogo from "@site/src/components/Icons/LetteringDocsLogo";
import clsx from "clsx";
import React from "react";
function getLogo(type) {
@@ -10,9 +11,21 @@ function getLogo(type) {
export default function NavbarLogo() {
const { pathname } = useLocation();
const type = pathname.length > 1 ? pathname.split("/")[1] : "home";
const [innerWidth, setInnerWidth] = React.useState(380);
React.useEffect(() => {
if (typeof window !== 'undefined') {
window.addEventListener("resize", () => {
setInnerWidth(window.innerWidth);
});
}
}
, []);
return (
<div className="flex items-center ml-2" style={{ display: window.innerWidth < 380 ? 'none' : 'flex' }}>
<div className={clsx("items-center ml-2", innerWidth < 380 ? "hidden" : "flex")}>
<Link to={`/${type}`}>
{getLogo(type)}
</Link>

View File

@@ -12,8 +12,8 @@ export default function Root({ children }) {
const [isIFrame, setIsIFrame] = useState(false);
const [posthogLoaded, setPosthogLoaded] = useState(false);
useEffect(() => {
setIsIFrame(window.self !== window.top);
if (window.self !== window.top) {
setIsIFrame(window?.self !== window?.top);
if (window?.self !== window?.top) {
document.addEventListener("keydown", (e) => {
if ((e.metaKey || e.ctrlKey) && e.key === "k") {
e.preventDefault();