jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-09 10:51:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'develop' into hotfix/github-things

Browse Source
This commit is contained in:
James Maslek
2023-02-02 11:14:04 -05:00
committed by GitHub
parent fe949f2d36 b3a1f6706b
commit c094506f07
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
website/README.md vendored
View File

@@ -1,6 +1,6 @@
# OpenBB Documentation Website
This repository contains the source code for the OpenBB Documentation Website.
This repository contains the source code for the OpenBB Documentation Website.
The website was built using [Docusaurus](https://docusaurus.io/), a modern static website generator and [TailwindCSS](https://tailwindcss.com) as styling solution.
The final website can be found at [https://docs.openbb.co](https://docs.openbb.co).
@@ -60,11 +60,21 @@ This command generates static content into the `build` directory and can be serv
## Run tests
```bash
pytest tests/website --autodoc
```
> If tests are run locally, the `--autodoc` flag is required, otherwise tests will be skipped.
> To install necessary dependencies for tests, run `poetry install -E doc` in the root directory of the repository.
## Contributing
We welcome contributions to the OpenBB Documentation Website.
---
---
<details><summary>DEPRECATED - OLD README</summary>
<p>