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

Improve the Hugo documentation to be more accessible and user-friendly #1891

Merged
merged 10 commits into from
Jun 2, 2022
2 changes: 1 addition & 1 deletion website/config.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
baseURL = "https://openbb-finance.github.io/OpenBBTerminal"
title = "OpenBB Terminal"
title = "OpenBB Documentation"
theme = "hugo-geekdoc"

# Required to get well formatted code blocks
Expand Down
327 changes: 290 additions & 37 deletions website/content/_index.md

Large diffs are not rendered by default.

23 changes: 7 additions & 16 deletions website/content/api/_index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,17 @@
---
title: OpenBB API
geekdocCollapseSection: true
---

{{< toc-tree >}}
The OpenBB Python API was created to enable usage of the terminal functionality in python
scripts and IPython Notebooks (Jupyter). The API wraps the functionality of the terminal in a way that the Python
commands follow the same convention as the terminal.

<img width="1356" alt="image" src="https://user-images.githubusercontent.com/11668535/157916097-f9c5af6f-b97f-476d-943e-49eea4283bed.png">


- [GST python API](#gst-python-api)
- [Python environment setup](#python-environment-setup)
- [Understanding the API functions](#understanding-the-api-functions)
- [Usage examples](#usage-examples)
- [External matplotlib axes support](#external-matplotlib-axes-support)

## GST python API
For example `stocks/load aapl` becomes `openbb.stocks.load("aapl")`.

The GST python API was created to enable usage of the terminal functionality in python
scripts and IPython Notebooks (Jupyter).
The API wraps the functionality of the terminal in a way that the python commands follow
the same convention as the terminal.
<a target="_blank" href="https://user-images.githubusercontent.com/11668535/157916097-f9c5af6f-b97f-476d-943e-49eea4283bed.png"><img width="500" alt="image" src="https://user-images.githubusercontent.com/11668535/157916097-f9c5af6f-b97f-476d-943e-49eea4283bed.png"></a>

For example `stocks/load aapl` becomes `openbb.stocks.load("aapl")`.
{{< toc >}}

---

Expand Down
35 changes: 27 additions & 8 deletions website/content/bots/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,37 @@
geekdocCollapseSection: true
---

[Our personal bet on financial bots and how they will render other finance chatting tools useless.](https://twitter.com/openbb_finance/status/1501380282884268037)
The purpose of the Financial Chatting bots are to remove the need of you and your group of friends /colleagues
migrating to any chatting tool to use the terminal capabilities. Instead, our OpenBB Terminal Bot will seamlessly
integrate with your already existing conversations/chats/servers.

TL;DR: We remove the need of you and your group of friends/colleagues migrating to any chatting tool to use the the terminal capabilities. Instead, our OpenBB Terminal Bot will seamlessly integrate with your already existing conversations/chats/servers.
{{< columns >}}

## Discord Bot
### Discord, Telegram, Slack and GroupMe integration

The only cross-platform financial chatting bot to accommodate for your already existing groups/chats/servers.
We will go in detail regarding the commands within [Discord Bot](/OpenBBTerminal/bots/discord/).
However, for the other chatting platforms, we will just list the main differences as
the commands are expected to be invoked in the same manner.

However, for the other chatting platforms, we will just list the main differences as the commands are expected to be invoked in the same manner.
<--->

**Supported bots:**
### Investment data should be OS agnostic

- [Telegram](/OpenBBTerminal/bots/telegram/)
- [Slack](/OpenBBTerminal/bots/slack/)
- [GroupMe](/OpenBBTerminal/bots/groupme/)
This bot will allow to access the terminal features using any type of device. From mobile phone to tablet and computer.

{{< /columns >}}

{{< columns >}}

### Use bot for your own investment research

If you don't want to engage with the bot in an open-server setting, you can message the bot directly and interact with data on a more private setting.

<--->

### Customize the bot to your needs

The bot also benefits from an MIT Open Source license, which means that you can customize it according to your needs and include proprietary features.

{{< /columns >}}
323 changes: 45 additions & 278 deletions website/content/terminal/_index.md

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions website/content/terminal/stocks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,29 +93,29 @@ a stock ticker, these menus can now be used in combination with the chosen stock
The Stock menu has an extensive list of available sub-menus ranging from fundamental analysis to sector analysis to
advanced prediction techniques. To find more information about each menu, click on one of the following:

- <a href="trading_hours" target="_blank">Introduction to Trading Hours</a>: discover exchanges that are currently open or
- <a href="tradinghours" target="_blank">Introduction to Trading Hours</a>: discover exchanges that are currently open or
closed for a specified ticker. Also find relevant information about each exchange.
- <a href="options" target="_blank">Introduction to Options</a>: look into available options, option spreads,
open interest and binomial valuation models.
- <a href="stock_discovery" target="_blank">Introduction to Stock Discovery</a>: discover trending stocks based on return metrics, revenue and earnings growth,
- <a href="discovery" target="_blank">Introduction to Stock Discovery</a>: discover trending stocks based on return metrics, revenue and earnings growth,
penny stocks and based on upcoming earnings release dates.
- <a href="sector_industry_analysis" target="_blank">Introduction to Sector & Industry Analysis</a>: analyse companies that reside in the same industry, sector and/or country and
- <a href="sia" target="_blank">Introduction to Sector & Industry Analysis</a>: analyse companies that reside in the same industry, sector and/or country and
share a similar market cap to determine potential under- and out performance of each company.
- <a href="dark_pools" target="_blank">Introduction to Dark Pools</a>: discover companies that have enormous shorting pressure, obtain information about dark pool positions and
- <a href="dark_pool_shorts" target="_blank">Introduction to Dark Pools</a>: discover companies that have enormous shorting pressure, obtain information about dark pool positions and
find out about shares that failed to deliver.
- <a href="stock_screener" target="_blank">Introduction to Stock Screener</a>: provides the ability to screen companies that share a similar characteristic,
- <a href="screener" target="_blank">Introduction to Stock Screener</a>: provides the ability to screen companies that share a similar characteristic,
for example unusual volumes, overbought or that include analyst upgrades, and be able to compare valuations and performance.
- <a href="insider_trading" target="_blank">Introduction to Insider Trading</a>: explains what large insiders, e.g. a CEO of a company, is buying the chosen company and insider trading activity for the chosen company.
- <a href="insider" target="_blank">Introduction to Insider Trading</a>: explains what large insiders, e.g. a CEO of a company, is buying the chosen company and insider trading activity for the chosen company.
- <a href="government" target="_blank">Introduction to Government</a>: gives insights in what the House of Congress is trading and the corporate lobbying that is performed.
- <a href="behavioural_analysis" target="_blank">Introduction to Behavioural Analysis</a>: gives the abilities to discover how different social media platforms view the chosen company and what is written about them.
- <a href="/OpenBBTerminal/terminal/common/behavioural_analysis" target="_blank">Introduction to Behavioural Analysis</a>: gives the abilities to discover how different social media platforms view the chosen company and what is written about them.
- <a href="comparison_analysis" target="_blank">Introduction to Comparison Analysis</a>: have the ability to compare companies based on, among other things, correlation, financial statements, sentiment, valuations and performance.
- <a href="fundamental_analysis" target="_blank">Introduction to Fundamental Analysis</a>: look into the fundamentals of a chosen company including financial statements, SEC filings, investing scores, discounted cash flow analysis (DCF),
sustainability scores and key ratios.
- <a href="due_diligence" target="_blank">Introduction to Due Diligence</a>: explore analyst recommendations, ratings over time, price targets and quarterly and yearly earnings estimates.
- <a href="strategy_backtesting" target="_blank">Introduction to Strategy Backtesting</a>: explore back testing strategies based on technical indicators.
- <a href="technical_analysis" target="_blank">Introduction to Technical Analysis</a>: analysis the chosen company's historical data extensively with moving averages and momentum, trend, volatility and volume indicators.
- <a href="quantitative_analysis" target="_blank">Introduction to Quantitative Analysis</a>: delve deeper in the historical data with quantitative methods including cumulative distribution function (CDF), (conditional) Value at Risk and rolling ratios.
- <a href="prediction_techniques" target="_blank">Introduction to Prediction Techniques</a>: apply advanced AI and Machine Learning models to form prediction of future stock prices including Recurrent Neural Network (RNN),
- <a href="backtesting" target="_blank">Introduction to Strategy Backtesting</a>: explore back testing strategies based on technical indicators.
- <a href="/OpenBBTerminal/terminal/common/technical_analysis" target="_blank">Introduction to Technical Analysis</a>: analysis the chosen company's historical data extensively with moving averages and momentum, trend, volatility and volume indicators.
- <a href="/OpenBBTerminal/terminal/common/quantitative_analysis" target="_blank">Introduction to Quantitative Analysis</a>: delve deeper in the historical data with quantitative methods including cumulative distribution function (CDF), (conditional) Value at Risk and rolling ratios.
- <a href="/OpenBBTerminal/terminal/common/prediction_techniques" target="_blank">Introduction to Prediction Techniques</a>: apply advanced AI and Machine Learning models to form prediction of future stock prices including Recurrent Neural Network (RNN),
Autoregressive Integrated Moving Average (ARIMA) and Monte Carlo forecasting.

## Examples
Expand Down

This file was deleted.

This file was deleted.

10 changes: 5 additions & 5 deletions website/data/menu/main.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
main:
- name: terminal
ref: "/terminal"
- name: OpenBB Terminal
ref: "/"
sub:
- name: stocks
ref: "/terminal/stocks"
Expand Down Expand Up @@ -1082,7 +1082,7 @@ main:
ref: "/terminal/common/quantitative_analysis/line"
- name: raw
ref: "/terminal/common/quantitative_analysis/raw"
- name: etf
- name: ETFs
ref: "/terminal/etf"
sub:
- name: ln
Expand Down Expand Up @@ -1415,9 +1415,9 @@ main:
ref: "/terminal/jupyter/dashboards/shortdata"
- name: "reports"
ref: "/terminal/jupyter/reports"
- name: "GST python API"
- name: "OpenBB Python API"
ref: "/api"
- name: "bots"
- name: "OpenBB Bots"
ref: "/bots"
sub:
- name: "Discord"
Expand Down
1 change: 1 addition & 0 deletions website/themes/hugo-geekdoc/layouts/shortcodes/toc.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{{ $tocLevels := default (default 6 .Site.Params.GeekdocToC) .Page.Params.GeekdocToC }}

{{ if and $tocLevels .Page.TableOfContents }}
<h2>Table of Contents</h2>
<div class="gdoc-toc gdoc-toc__level--{{$tocLevels}}">{{ .Page.TableOfContents }}<hr></div>
{{ end }}