Skip to content

Commit

Permalink
Merge pull request #4099 from OpenBB-finance/feature/improve-website-…
Browse files Browse the repository at this point in the history
…readme

Improve website readme
  • Loading branch information
jmaslek authored Feb 2, 2023
2 parents aa60a71 + 35e78b9 commit b3a1f67
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down Expand Up @@ -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>

Expand Down

0 comments on commit b3a1f67

Please sign in to comment.