summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames Maslek <jmaslek11@gmail.com>2024-06-14 10:54:15 -0400
committerJames Maslek <jmaslek11@gmail.com>2024-06-14 10:54:15 -0400
commit9d20e78db65750f5c367228cc1707a7a8ff45420 (patch)
tree0d5095aeed37dade3a9395025a43afde79c7bf54
parent806a0e1112300568ddc2f3251e7c043f3e61653b (diff)
parenta11489614ddca84da4b81adf87dcbe80a36b0395 (diff)
Merge branch 'main' into docs/rename
-rw-r--r--.github/workflows/deploy-gh-pages.yml3
-rw-r--r--website/content/cli/configuration.md4
-rw-r--r--website/content/cli/data-sources.md2
-rw-r--r--website/content/cli/installation.md31
-rw-r--r--website/content/platform/developer_guide/index.mdx2
-rw-r--r--website/content/platform/user_guides/add_toolkit_extension.mdx2
-rw-r--r--website/content/platform/user_guides/basic_syntax.mdx2
-rw-r--r--website/content/platform/user_guides/extensions.mdx (renamed from website/content/platform/developer_guide/extensions.mdx)0
8 files changed, 27 insertions, 19 deletions
diff --git a/.github/workflows/deploy-gh-pages.yml b/.github/workflows/deploy-gh-pages.yml
index bde7ca3ca0b..51116d012fa 100644
--- a/.github/workflows/deploy-gh-pages.yml
+++ b/.github/workflows/deploy-gh-pages.yml
@@ -50,10 +50,9 @@ jobs:
- name: Generate Platform Markdown
run: |
- poetry install -C openbb_platform --no-interaction
+ poetry install -C openbb_platform --no-interaction -E all
source openbb_platform/.venv/bin/activate
pip install -U poetry
- pip install toml
python openbb_platform/dev_install.py -e all
python -c "import openbb; openbb.build()"
python website/generate_platform_v4_markdown.py
diff --git a/website/content/cli/configuration.md b/website/content/cli/configuration.md
index 9ade9e69d4b..90216554af7 100644
--- a/website/content/cli/configuration.md
+++ b/website/content/cli/configuration.md
@@ -18,12 +18,12 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Configuration & Settings - | OpenBB Platform CLI Docs" />
-In addition to the OpenBB Platform's `user_settings.json` file, described [here](/platform/usage/settings_and_environment_variables), there are settings and environment variables affecting the CLI only.
+In addition to the OpenBB Platform's `user_settings.json` file, described [here](/platform/user_guides/settings_and_environment_variables), there are settings and environment variables affecting the CLI only.
:::important
API credentials are defined in the `user_settings.json` file.
-Find all data providers [here](/platform/extensions/data_extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials).
+Find all data providers [here](/platform/user_guides/extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials).
Define default data sources by following the pattern outlined [here](data-sources)
:::
diff --git a/website/content/cli/data-sources.md b/website/content/cli/data-sources.md
index aa79329da1f..7ded01b8bea 100644
--- a/website/content/cli/data-sources.md
+++ b/website/content/cli/data-sources.md
@@ -26,7 +26,7 @@ Many commands have multiple data sources associated with it. This page describes
:::important
API credentials are defined in the `user_settings.json` file.
-Find all data providers [here](/platform/extensions/data_extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials).
+Find all data providers [here](/platform/user_guides/extensions/), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials).
:::
## Data Source In-Command
diff --git a/website/content/cli/installation.md b/website/content/cli/installation.md
index b26cb516659..abde7a52b96 100644
--- a/website/content/cli/installation.md
+++ b/website/content/cli/installation.md
@@ -25,9 +25,24 @@ The OpenBB Platform CLI is a wrapper around the [Platform](/platform), and shoul
Please refer to the [OpenBB Platform install documentation](/platform/installation) for instructions and more information.
:::info
-If the OpenBB Platform is not already installed, the `openbb-cli` package will install the default components.
+If the OpenBB Platform is not already installed, the `openbb-cli` package will install all available components.
:::
+### Windows
+
+The machine may need to have an installation of Visual C++ Build Tools available. Download the elements highlighted in the images below.
+
+<details>
+<summary mdxType="summary">"Microsoft Visual C++ 14.0 or greater is required"</summary>
+
+Download and install [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), restart the machine, then continue.
+
+![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/ceb57be0-6dae-42f2-aca6-bf62ce7d6135)
+
+![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f8aef8fc-a080-4164-bd36-460714ec44f3)
+
+</details>
+
### Linux Requirements
Linux users will need to take additional steps prior to installation.
@@ -71,26 +86,20 @@ Welcome to OpenBB Platform CLI v1.0.0
Follow the instructions [here](/platform/installation#source) to clone the GitHub repo and install the OpenBB Platform from the source code.
-Next, navigate into the folder: `~/OpenBBTerminal/cli`
+Next, navigate into the folder: `~/OpenBBTerminal/openbb_platform`
:::tip
-The Python environment should have `toml` and `poetry` installed.
+The Python environment should have `poetry` installed.
```bash
-pip install toml poetry
+pip install poetry
```
:::
Finally, enter:
```console
-poetry install
-```
-
-Alternatively, install locally with `pip`:
-
-```bash
-pip install -e .
+python dev_install.py -e --cli
```
## Installing New Modules
diff --git a/website/content/platform/developer_guide/index.mdx b/website/content/platform/developer_guide/index.mdx
index 70b8518ec01..04af71994a8 100644
--- a/website/content/platform/developer_guide/index.mdx
+++ b/website/content/platform/developer_guide/index.mdx
@@ -62,4 +62,4 @@ Optional extras are not included with the base installation, and these include:
- Toolkit extensions
- CLI Terminal
-Refer to [Extensions](/platform/developer_guide/extensions) for the list of extensions hosted in the OpenBB GitHub repository that can be installed independently.
+Refer to [Extensions](/platform/user_guides/extensions) for the list of extensions hosted in the OpenBB GitHub repository that can be installed independently.
diff --git a/website/content/platform/user_guides/add_toolkit_extension.mdx b/website/content/platform/user_guides/add_toolkit_extension.mdx
index 86af1233bae..b712f5194b3 100644
--- a/website/content/platform/user_guides/add_toolkit_extension.mdx
+++ b/website/content/platform/user_guides/add_toolkit_extension.mdx
@@ -24,7 +24,7 @@ import HeadTitle from "@site/src/components/General/HeadTitle.tsx";
<HeadTitle title="Build New Toolkit Extension - How-To | OpenBB Platform Docs" />
-Before adding a new toolkit extension and router path to the OpenBB Platform using a supplied template, it is important to understand the difference between a toolkit and a provider extension. You can find more information on this [here](/platform/developer_guide/extensions).
+Before adding a new toolkit extension and router path to the OpenBB Platform using a supplied template, it is important to understand the difference between a toolkit and a provider extension. You can find more information on this [here](/platform/user_guides/extensions).
## How To Create A Router Extension
diff --git a/website/content/platform/user_guides/basic_syntax.mdx b/website/content/platform/user_guides/basic_syntax.mdx
index eb9db88c8a4..b030c5a66e9 100644
--- a/website/content/platform/user_guides/basic_syntax.mdx
+++ b/website/content/platform/user_guides/basic_syntax.mdx
@@ -80,7 +80,7 @@ Provider coverage can be ascertained with the command below:
obb.coverage.providers
```
-Refer to, [Data Extensions](/platform/developer_guide/extensions), for instructions on installing data provider extensions.
+Refer to, [Data Extensions](/platform/user_guides/extensions), for instructions on installing data provider extensions.
## Symbol
diff --git a/website/content/platform/developer_guide/extensions.mdx b/website/content/platform/user_guides/extensions.mdx
index feed0a5ea27..feed0a5ea27 100644
--- a/website/content/platform/developer_guide/extensions.mdx
+++ b/website/content/platform/user_guides/extensions.mdx