From 56849d7f256e3c8e6cf74ba2ad744486d2fcee13 Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Wed, 1 Feb 2023 10:54:25 +0000 Subject: [PATCH] small tests section --- website/README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/website/README.md b/website/README.md index 1ab77d9fdbb..a5e49611337 100644 --- a/website/README.md +++ b/website/README.md @@ -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. ---- +---
DEPRECATED - OLD README