Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A lot of improvements to the Hugo documentation #1893

Merged
merged 8 commits into from
Jun 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ As a modern Python-based environment, OpenBBTerminal opens access to numerous Py

If you wish to install the Terminal, there are currently four options:

- [Using the Installer](https://openbb-finance.github.io/OpenBBTerminal/terminal/#accessing-the-openbb-terminal) (recommended if you just want to use the terminal)
- [Using the Installer](https://openbb-finance.github.io/OpenBBTerminal/#accessing-the-openbb-terminal) (recommended if you just want to use the terminal)
- [Using Python](openbb_terminal/README.md#anaconda--python) (recommended if you want to develop new features)
- [Using Docker](openbb_terminal/README.md#Docker-Installation) (alternative option to the installer if preferred)
- [Using Docker Web UI](openbb_terminal/README.md#web-ui---docker) (if you want to deploy the web UI for users to access
Expand Down
2 changes: 1 addition & 1 deletion website/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ enableGitInfo = true

# (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc
# relative to your 'static/' folder.
geekdocLogo = "gst_logo_green.png"
geekdocLogo = "openbb_logo.png"

# (Optional, default false) Render menu from data file im 'data/menu/main.yaml'.
geekdocMenuBundle = true
Expand Down
121 changes: 81 additions & 40 deletions website/content/_index.md

Large diffs are not rendered by default.

Binary file not shown.
2 changes: 1 addition & 1 deletion website/content/terminal/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,6 @@ Navigate through 750+ terminal features using fast shortcuts and leverage auto-c
[bugs-closed-shield]: https://img.shields.io/github/issues-closed/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=success
[bugs-closed-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aclosed
[license-shield]: https://img.shields.io/github/license/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE.txt
[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE
[twitter-shield]: https://img.shields.io/twitter/follow/openbb_finance?style=for-the-badge&color=blue
[twitter-url]: https://twitter.com/openbb_finance
3 changes: 3 additions & 0 deletions website/content/terminal/alternative/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
geekdocCollapseSection: true
---

Investors utilize alternative data to analyze a company or investment that is not available through typical data sources (financial statements, SEC filings, management presentations, press releases, etc.). Traditional data sources do not provide investors with as accurate, timely, or granular insights and measurements into corporate performance as alternative data does. Increases in computing power and personal device usage have resulted in tremendous data production during the previous ten years. As a result, a slew of new businesses have sprung up to collect, clean, analyze, and interpret data in order to sell it as a product that might help investors make better decisions.

**Available commands**
{{< toc-tree >}}
1 change: 1 addition & 0 deletions website/content/terminal/alternative/covid/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
geekdocCollapseSection: true
---

**Available commands:**
{{< toc-tree >}}
1 change: 1 addition & 0 deletions website/content/terminal/alternative/oss/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
geekdocCollapseSection: true
---

**Available commands:**
{{< toc-tree >}}
5 changes: 5 additions & 0 deletions website/content/terminal/common/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@
geekdocCollapseSection: true
---

The Common menu is a menu that serves the purpose of being able to make multiple analysis techniques available
on multiple menus within the Terminal. E.g. technical and quantitative analysis is available for both stocks and
cryptocurrencies.

**Available commands**
{{< toc-tree >}}
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
geekdocCollapseSection: true
---

**Prediction Techniques** are methods of using historical data to train machine learning models that can predict future outcomes based on statistical computations. Predictive analytics is being used by businesses to tackle difficulties such as choosing which items to advertise to specific client segments and on which platforms, as well as uncover new insights from existing data. Predictive modeling is defined as the process of approximating a mapping function (f) from input variables (X) to output variables (Y).

**Available commands**
{{< toc-tree >}}
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
geekdocCollapseSection: true
---

In finance and investment management, **Quantitative Analysis** refers to the application of mathematical and statistical methodologies. Quantitative analysts are those that work in this subject (quants). Quants typically focus on a few topics, such as derivative structure or pricing, risk management, algorithmic trading, and investment management. Industrial mathematics jobs are similar to those in other industries. The procedure usually entails scanning through large databases for patterns, such as correlations between liquid assets or price movement patterns (trend following or mean reversion). High-frequency trading may be used in the resulting strategies.

**Available commands**
{{< toc-tree >}}
3 changes: 3 additions & 0 deletions website/content/terminal/common/technical_analysis/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
geekdocCollapseSection: true
---

The study of financial market action is known as **Technical Analysis**. The technician examines price changes that occur on a daily, weekly, or monthly basis, or over any other fixed time period displayed graphically as charts. As a result, the term "chart analysis" was coined. A chartist merely looks at price charts, whereas a technical analyst looks at technical indications resulting from price changes as well. Instead of looking at the fundamental causes that (appear to) influence market prices, technical analysts look at how the financial markets behave. Even if all relevant information about a specific market or stock were accessible, technicians believe it would be impossible to forecast an exact market "reaction" to that information.

**Available commands**
{{< toc-tree >}}
5 changes: 5 additions & 0 deletions website/content/terminal/cryptocurrency/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@
geekdocCollapseSection: true
---

Cryptocurrency is a type of electronic money. This sort of currency employs blockchain technology, which is regarded as secure since it can achieve distributed consensus even among untrustworthy people. Cryptocurrency blockchains are similar to traditional bookkeepers' ledgers, with the exception that the ledger is electronic and anybody with access to it can act as the bookkeeper.

Cryptocurrency has attracted investors from all across the world, and more are on the way. Though Bitcoin is the most well-known digital currency, there are thousands of others. 1 Cryptocurrency is one of the most innovative and intriguing asset classes available to investors.

**Available commands**
{{< toc-tree >}}
3 changes: 3 additions & 0 deletions website/content/terminal/cryptocurrency/defi/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
geekdocCollapseSection: true
---

DeFi (short for "decentralized finance") refers to financial services provided by public blockchains, most notably Ethereum. You can earn interest, borrow, lend, purchase insurance, trade derivatives, exchange assets, and more with DeFi, but it's faster and doesn't involve paperwork or a third party. DeFi is global, peer-to-peer (directly between two people, not through a centralized system), pseudonymous, and available to anyone, just like crypto in general.

**Available commands:**
{{< toc-tree >}}
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
geekdocCollapseSection: true
---
Due diligence is a process that involves doing an investigation, audit, or review to verify facts or information about a subject. Due diligence in the financial industry entails a review of financial records prior to entering into a proposed deal with another party.

**Available commands**
{{< toc-tree >}}
3 changes: 3 additions & 0 deletions website/content/terminal/cryptocurrency/nft/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
geekdocCollapseSection: true
---

A digital asset that depicts real-world elements like as art, music, in-game items, and films is known as an NFT. They're bought and traded online, often using cryptocurrency, and they're usually encoded with the same software as many other cryptos.

**Available commands:**
{{< toc-tree >}}
3 changes: 3 additions & 0 deletions website/content/terminal/cryptocurrency/onchain/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
geekdocCollapseSection: true
---

On-chain analysis is a way of determining market sentiment by leveraging data from a blockchain ledger. More precisely, it entails examining transaction data and crypto wallet balances, both of which are helpful when deciding whether or not to invest. After all, if a token isn't traded and the great bulk of its circulating supply is controlled by a few large investors known as whales, investing in it is generally not a wise idea.

**Available commands:**
{{< toc-tree >}}
1 change: 1 addition & 0 deletions website/content/terminal/cryptocurrency/overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
geekdocCollapseSection: true
---

**Available commands:**
{{< toc-tree >}}

This file was deleted.

1 change: 1 addition & 0 deletions website/content/terminal/cryptocurrency/tools/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
geekdocCollapseSection: true
---

**Available commands:**
{{< toc-tree >}}
1 change: 1 addition & 0 deletions website/content/terminal/econometrics/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ The menu allows the user to load in his/her own dataset(s), modify the data by (
indices, apply statistical tests (e.g. Breusch-Godfrey autocorrelation tests) as well as OLS regressions and Panel
regressions (e.g. Random Effects and Fixed Effects)

**Available commands**
{{< toc-tree >}}

3 changes: 3 additions & 0 deletions website/content/terminal/economy/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
geekdocCollapseSection: true
---

Economics is concerned with the actions and interactions of economic agents as well as the functioning of economies. Microeconomics is a branch of economics that studies the fundamental parts of the economy, such as individual agents and markets, as well as their interactions and effects. Households, businesses, buyers, and sellers are all examples of individual agents. Macroeconomics studies the economy as a system in which production, consumption, saving, and investment interact, as well as the factors that influence it, such as the use of labor, capital, and land, currency inflation, economic growth, and public policies that affect these aspects.

**Available commands**
{{< toc-tree >}}

This file was deleted.

This file was deleted.

6 changes: 6 additions & 0 deletions website/content/terminal/etf/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
---
title: Exchange Traded Funds (ETFs)
geekdocCollapseSection: true
---

In recent years, exchange-traded funds have become one of the most essential and profitable products offered for individual investors. ETFs have a number of advantages and, when used properly, can help investors accomplish their investment objectives.

In a nutshell, an ETF is a collection of securities that may be purchased or sold on a stock exchange through a brokerage business. ETFs are available in almost every asset class imaginable, ranging from standard investments to so-called nontraditional assets such as commodities and currencies. Furthermore, new ETF formats enable investors to short markets, obtain leverage, and avoid paying short-term capital gains taxes.

**Available commands**
{{< toc-tree >}}
1 change: 1 addition & 0 deletions website/content/terminal/etf/disc/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
geekdocCollapseSection: true
---

**Available commands:**
{{< toc-tree >}}
7 changes: 6 additions & 1 deletion website/content/terminal/forex/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
geekdocCollapseSection: true
---

## TODO: Update after refactoring
Forex trading takes place in the foreign exchange market. Currency is significant because it allows us to buy goods and services both locally and internationally. To undertake international trade and business, international currencies must be exchanged.

If you live in the United States and wish to purchase goods from Europe, you or the firm from which you purchase the goods must pay in euros (EUR). This means that the importer in the United States would have to convert the same amount of dollars (USD) into euros.

The same is true when it comes to traveling. Because euros are not accepted in China, visitors must exchange euros for the local currency.

**Available commands**
{{< toc-tree >}}
3 changes: 2 additions & 1 deletion website/content/terminal/forex/oanda/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
geekdocCollapseSection: true
---

## TODO: Update after refactoring
OANDA Corporation is a foreign exchange company that provides internet-based forex trading and currency information services.

**Available commands:**
{{< toc-tree >}}
5 changes: 3 additions & 2 deletions website/content/terminal/funds/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
geekdocCollapseSection: true
---

{{< toc-tree >}}
Funds are a collection of money set aside for a specific purpose. A fund can be created for a variety of reasons, such as a municipal government putting money aside to build a new civic center, a college putting money away to grant a scholarship, or an insurance company putting money aside to settle its customers' claims.

Mutual funds
**Available commands**
{{< toc-tree >}}
5 changes: 3 additions & 2 deletions website/content/terminal/jupyter/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
geekdocCollapseSection: true
---

{{< toc-tree >}}
Create notebook templates (through papermill) which can be run on different tickers. This level of automation allows speeding up the development of your investment thesis and reduce human error.

Jupyter
**Available commands**
{{< toc-tree >}}
5 changes: 2 additions & 3 deletions website/content/terminal/jupyter/dashboards/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,5 @@
geekdocCollapseSection: true
---

{{< toc-tree >}}

Dashboards
**Available commands:**
{{< toc-tree >}}
27 changes: 5 additions & 22 deletions website/content/terminal/portfolio/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,11 @@
geekdocCollapseSection: true
---

{{< toc-tree >}}
A **Portfolio** is a collection of financial assets such as stocks, bonds, commodities, cash, and cash equivalents, as well as closed-end funds and exchange-traded funds (ETFs). Stocks, bonds, and cash are commonly seen to be the foundation of a portfolio. This isn't always the case, but it doesn't have to be. Real estate, art, and private investments are all examples of assets that can be found in a portfolio.

```text
(✨) / $ portfolio
**Portfolio Attribution** is a complex way for evaluating a portfolio or fund manager's performance. It aims to objectively assess components of an active fund manager's investment selections and decisions—and to discover sources of excess returns, especially when contrasted to an index or other benchmark. It is also known as "return attribution" or "performance attribution." This can be a useful technique for portfolio managers and investment firms to evaluate strategies. For investors, attribution analysis is a useful tool for evaluating fund or money manager performance.

What do you want to do?
**Portfolio optimization** is usually referred to as Modern Portfolio Theory (MPT). This is started by the famous paper from Harry Markowitz that shows “that the performance of an individual stock is not as important as the performance and composition of an investor's entire portfolio.” The biggest criticism of the MPT that if two portfolios have equal variance and equal return, the MPT is indifferent what portfolio you choose even though the downside risk of one portfolio could be much higher than that of the other, meaning significant losses can be sporadic (but large) for one portfolio while frequent (but of smaller size) for the other while having the same variance. This is where Post-Modern Portfolio Theory (PMPT) makes proper adjustments for. The main difference: “The differences in risk, as defined by the standard deviation of returns, between the PMPT and the MPT is the key factor in portfolio construction. The MPT assumes symmetrical risk whereas the PMPT assumes asymmetrical risk. Downside risk is measured by target semi-deviation, termed downside deviation, and captures what investors fear most: having negative returns.” This goes deeper into the concept of Utility and Risk Aversion where the perceived negative impact of -10% is larger than the perceived positive impact of 10%.

> bro brokers holdings, supports: robinhood, ally, degiro, coinbase
> po portfolio optimization, optimal portfolio weights from pyportfolioopt
> pa portfolio analysis, analyse portfolios

Portfolio:
load load data into the portfolio
save save your portfolio for future use
show show existing transactions
add add a security to your portfolio
rmv remove a security from your portfolio

Reports:
ar annual report for performance of a given portfolio

Graphs:
rmr graph your returns versus the market's returns
al displays the allocation of the portfolio
```
**Available commands**
{{< toc-tree >}}
5 changes: 4 additions & 1 deletion website/content/terminal/portfolio/brokers/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
geekdocCollapseSection: true
---

## TODO: Update after refactoring
A broker is a person or company who works as a go-between for an investor and a securities exchange. Individual traders and investors require the services of exchange members since securities exchanges only accept orders from persons or organizations that are members of the exchange.

Brokers provide that service and are paid in a variety of methods, including commissions, fees, and payments from the exchange itself. Investopedia examines all of the top brokers on a regular basis and keeps a list of the finest online brokers and trading platforms to assist investors in determining which broker is right for them.

**Available commands:**
{{< toc-tree >}}
7 changes: 0 additions & 7 deletions website/content/terminal/resources/_index.md

This file was deleted.

4 changes: 4 additions & 0 deletions website/content/terminal/stocks/backtesting/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
---
geekdocCollapseSection: true
---
Backtesting allows analysts to test and compare different trading strategies without risking any money. According to the hypothesis, if their strategy failed in the past, it is unlikely to succeed in the future (and vice versa). During testing, the total profitability and the level of risk taken are the two most important factors to consider.

A backtest, on the other hand, examines a strategy's performance in relation to a variety of variables. A successful backtest will show traders a technique that has previously produced positive outcomes. While the market never moves in the same way twice, backtesting is based on the notion that equities follow similar patterns in the past.

**Available commands:**
{{< toc-tree >}}
3 changes: 3 additions & 0 deletions website/content/terminal/stocks/due_diligence/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
geekdocCollapseSection: true
---

Due diligence is a process that involves doing an investigation, audit, or review to verify facts or information about a subject. Due diligence in the financial industry entails a review of financial records prior to entering into a proposed deal with another party.

**Available commands**
{{< toc-tree >}}
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@
geekdocCollapseSection: true
---

Fundamental analysis (FA) is a way of determining the intrinsic value of a securities by looking at connected economic and financial elements. Fundamental analysts look at everything that can influence the value of a security, from macroeconomic issues like the state of the economy and industry circumstances to microeconomic elements like the company's management performance.

The ultimate goal is to arrive at a number that can be compared to the present price of a security to determine whether it is undervalued or overvalued.

**Available commands**
{{< toc-tree >}}
5 changes: 5 additions & 0 deletions website/content/terminal/stocks/government/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@
geekdocCollapseSection: true
---

A government is the system or collection of individuals in charge of governing a formally constituted community, such as a state. In its broadest sense, government is made up of three parts: legislature, executive branch, and judiciary. Government is both a tool of enforcing organizational policies and a system for defining policy. Many governments have a constitution, which is a statement of the government's guiding ideas and ideology.

Within this menu, the actions regarding lobbying, governmental contracts as well as governmental transactions are depicted.

**Available commands:**
{{< toc-tree >}}
5 changes: 5 additions & 0 deletions website/content/terminal/stocks/insider/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@
geekdocCollapseSection: true
---

Insider trading is when someone with non-public, substantial information about a public company's shares trades in that stock for whatever purpose. Depending on when the insider makes the trade, insider trading can be either unlawful or legal.

When material knowledge is still classified as confidential, insider trading is prohibited, and this type of insider trading carries severe penalties.

**Available commands:**
{{< toc-tree >}}
4 changes: 4 additions & 0 deletions website/content/terminal/stocks/options/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
---
geekdocCollapseSection: true
---
Options are in essence contracts between two parties that grant holders the right to buy or sell an underlying asset at a certain price within a certain time frame.

The underlying asset, which could be equities, bonds, currency, interest rates, market indexes, exchange-traded funds (ETFs), or futures contracts, determines the value of an option. Options are securities in and of themselves, similar to stocks and bonds, but they are referred to as derivatives because their value is derived from something else.

**Available commands:**
{{< toc-tree >}}
Loading