From 9db8ff4992c063d96c3268356ebc0124df3ae5be Mon Sep 17 00:00:00 2001 From: andrewkenreich Date: Wed, 1 Nov 2023 11:10:19 -0400 Subject: [PATCH] fix docs --- .../bot/reference/discord/alerts/index.mdx | 27 +++ .../bot/reference/discord/autopost/index.mdx | 22 +++ .../bot/reference/discord/charts/index.mdx | 57 ++++++ .../bot/reference/discord/crypto/index.mdx | 52 ++++++ .../bot/reference/discord/darkpool/index.mdx | 47 +++++ .../bot/reference/discord/discovery/index.mdx | 62 +++++++ .../reference/discord/duedilligence/index.mdx | 97 ++++++++++ .../bot/reference/discord/economy/index.mdx | 52 ++++++ .../bot/reference/discord/etf/index.mdx | 17 ++ .../bot/reference/discord/flow/index.mdx | 67 +++++++ .../bot/reference/discord/fun/index.mdx | 22 +++ .../bot/reference/discord/general/index.mdx | 47 +++++ .../reference/discord/government/index.mdx | 22 +++ .../content/bot/reference/discord/index.mdx | 102 +++++++++++ .../bot/reference/discord/info/index.mdx | 27 +++ .../bot/reference/discord/nft/index.mdx | 22 +++ .../bot/reference/discord/options/index.mdx | 117 ++++++++++++ .../bot/reference/discord/pop/index.mdx | 17 ++ .../bot/reference/discord/screeners/index.mdx | 37 ++++ .../reference/discord/short_data/index.mdx | 32 ++++ .../content/bot/reference/generate_index.py | 169 +++++++++--------- .../bot/reference/telegram/charts/index.mdx | 62 +++++++ .../bot/reference/telegram/crypto/index.mdx | 52 ++++++ .../bot/reference/telegram/darkpool/index.mdx | 47 +++++ .../reference/telegram/discovery/index.mdx | 47 +++++ .../reference/telegram/duediligence/index.mdx | 92 ++++++++++ .../bot/reference/telegram/economy/index.mdx | 47 +++++ .../bot/reference/telegram/etf/index.mdx | 17 ++ .../bot/reference/telegram/flow/index.mdx | 32 ++++ .../bot/reference/telegram/fun/index.mdx | 22 +++ .../bot/reference/telegram/general/index.mdx | 27 +++ .../reference/telegram/government/index.mdx | 22 +++ .../content/bot/reference/telegram/index.mdx | 92 ++++++++++ .../bot/reference/telegram/info/index.mdx | 17 ++ .../bot/reference/telegram/nft/index.mdx | 17 ++ .../bot/reference/telegram/options/index.mdx | 117 ++++++++++++ .../bot/reference/telegram/overview/index.mdx | 37 ++++ .../reference/telegram/screeners/index.mdx | 17 ++ .../reference/telegram/short_data/index.mdx | 32 ++++ 39 files changed, 1825 insertions(+), 85 deletions(-) create mode 100644 website/content/bot/reference/discord/alerts/index.mdx create mode 100644 website/content/bot/reference/discord/autopost/index.mdx create mode 100644 website/content/bot/reference/discord/charts/index.mdx create mode 100644 website/content/bot/reference/discord/crypto/index.mdx create mode 100644 website/content/bot/reference/discord/darkpool/index.mdx create mode 100644 website/content/bot/reference/discord/discovery/index.mdx create mode 100644 website/content/bot/reference/discord/duedilligence/index.mdx create mode 100644 website/content/bot/reference/discord/economy/index.mdx create mode 100644 website/content/bot/reference/discord/etf/index.mdx create mode 100644 website/content/bot/reference/discord/flow/index.mdx create mode 100644 website/content/bot/reference/discord/fun/index.mdx create mode 100644 website/content/bot/reference/discord/general/index.mdx create mode 100644 website/content/bot/reference/discord/government/index.mdx create mode 100644 website/content/bot/reference/discord/index.mdx create mode 100644 website/content/bot/reference/discord/info/index.mdx create mode 100644 website/content/bot/reference/discord/nft/index.mdx create mode 100644 website/content/bot/reference/discord/options/index.mdx create mode 100644 website/content/bot/reference/discord/pop/index.mdx create mode 100644 website/content/bot/reference/discord/screeners/index.mdx create mode 100644 website/content/bot/reference/discord/short_data/index.mdx create mode 100644 website/content/bot/reference/telegram/charts/index.mdx create mode 100644 website/content/bot/reference/telegram/crypto/index.mdx create mode 100644 website/content/bot/reference/telegram/darkpool/index.mdx create mode 100644 website/content/bot/reference/telegram/discovery/index.mdx create mode 100644 website/content/bot/reference/telegram/duediligence/index.mdx create mode 100644 website/content/bot/reference/telegram/economy/index.mdx create mode 100644 website/content/bot/reference/telegram/etf/index.mdx create mode 100644 website/content/bot/reference/telegram/flow/index.mdx create mode 100644 website/content/bot/reference/telegram/fun/index.mdx create mode 100644 website/content/bot/reference/telegram/general/index.mdx create mode 100644 website/content/bot/reference/telegram/government/index.mdx create mode 100644 website/content/bot/reference/telegram/index.mdx create mode 100644 website/content/bot/reference/telegram/info/index.mdx create mode 100644 website/content/bot/reference/telegram/nft/index.mdx create mode 100644 website/content/bot/reference/telegram/options/index.mdx create mode 100644 website/content/bot/reference/telegram/overview/index.mdx create mode 100644 website/content/bot/reference/telegram/screeners/index.mdx create mode 100644 website/content/bot/reference/telegram/short_data/index.mdx diff --git a/website/content/bot/reference/discord/alerts/index.mdx b/website/content/bot/reference/discord/alerts/index.mdx new file mode 100644 index 000000000000..022b3069ac95 --- /dev/null +++ b/website/content/bot/reference/discord/alerts/index.mdx @@ -0,0 +1,27 @@ +# alerts + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/autopost/index.mdx b/website/content/bot/reference/discord/autopost/index.mdx new file mode 100644 index 000000000000..34b19072200f --- /dev/null +++ b/website/content/bot/reference/discord/autopost/index.mdx @@ -0,0 +1,22 @@ +# autopost + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/charts/index.mdx b/website/content/bot/reference/discord/charts/index.mdx new file mode 100644 index 000000000000..b4e0b66bcf11 --- /dev/null +++ b/website/content/bot/reference/discord/charts/index.mdx @@ -0,0 +1,57 @@ +# charts + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/crypto/index.mdx b/website/content/bot/reference/discord/crypto/index.mdx new file mode 100644 index 000000000000..699b20dca51f --- /dev/null +++ b/website/content/bot/reference/discord/crypto/index.mdx @@ -0,0 +1,52 @@ +# crypto + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/darkpool/index.mdx b/website/content/bot/reference/discord/darkpool/index.mdx new file mode 100644 index 000000000000..999aef994477 --- /dev/null +++ b/website/content/bot/reference/discord/darkpool/index.mdx @@ -0,0 +1,47 @@ +# darkpool + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/discovery/index.mdx b/website/content/bot/reference/discord/discovery/index.mdx new file mode 100644 index 000000000000..3eb71a4f48d3 --- /dev/null +++ b/website/content/bot/reference/discord/discovery/index.mdx @@ -0,0 +1,62 @@ +# discovery + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/duedilligence/index.mdx b/website/content/bot/reference/discord/duedilligence/index.mdx new file mode 100644 index 000000000000..b90861042640 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/index.mdx @@ -0,0 +1,97 @@ +# duedilligence + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/economy/index.mdx b/website/content/bot/reference/discord/economy/index.mdx new file mode 100644 index 000000000000..d071282690bc --- /dev/null +++ b/website/content/bot/reference/discord/economy/index.mdx @@ -0,0 +1,52 @@ +# economy + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/etf/index.mdx b/website/content/bot/reference/discord/etf/index.mdx new file mode 100644 index 000000000000..0efeaa587099 --- /dev/null +++ b/website/content/bot/reference/discord/etf/index.mdx @@ -0,0 +1,17 @@ +# etf + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/flow/index.mdx b/website/content/bot/reference/discord/flow/index.mdx new file mode 100644 index 000000000000..4353b44597cd --- /dev/null +++ b/website/content/bot/reference/discord/flow/index.mdx @@ -0,0 +1,67 @@ +# flow + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/fun/index.mdx b/website/content/bot/reference/discord/fun/index.mdx new file mode 100644 index 000000000000..d3c5280e3268 --- /dev/null +++ b/website/content/bot/reference/discord/fun/index.mdx @@ -0,0 +1,22 @@ +# fun + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/general/index.mdx b/website/content/bot/reference/discord/general/index.mdx new file mode 100644 index 000000000000..ef68ba6f3402 --- /dev/null +++ b/website/content/bot/reference/discord/general/index.mdx @@ -0,0 +1,47 @@ +# general + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/government/index.mdx b/website/content/bot/reference/discord/government/index.mdx new file mode 100644 index 000000000000..990dad421e13 --- /dev/null +++ b/website/content/bot/reference/discord/government/index.mdx @@ -0,0 +1,22 @@ +# government + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/index.mdx b/website/content/bot/reference/discord/index.mdx new file mode 100644 index 000000000000..894b027fe444 --- /dev/null +++ b/website/content/bot/reference/discord/index.mdx @@ -0,0 +1,102 @@ +# OpenBB Discord Reference + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/info/index.mdx b/website/content/bot/reference/discord/info/index.mdx new file mode 100644 index 000000000000..af37c95070b3 --- /dev/null +++ b/website/content/bot/reference/discord/info/index.mdx @@ -0,0 +1,27 @@ +# info + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/nft/index.mdx b/website/content/bot/reference/discord/nft/index.mdx new file mode 100644 index 000000000000..896dc758e6bf --- /dev/null +++ b/website/content/bot/reference/discord/nft/index.mdx @@ -0,0 +1,22 @@ +# nft + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/options/index.mdx b/website/content/bot/reference/discord/options/index.mdx new file mode 100644 index 000000000000..4344701563f4 --- /dev/null +++ b/website/content/bot/reference/discord/options/index.mdx @@ -0,0 +1,117 @@ +# options + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/pop/index.mdx b/website/content/bot/reference/discord/pop/index.mdx new file mode 100644 index 000000000000..d069076d8d70 --- /dev/null +++ b/website/content/bot/reference/discord/pop/index.mdx @@ -0,0 +1,17 @@ +# pop + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/screeners/index.mdx b/website/content/bot/reference/discord/screeners/index.mdx new file mode 100644 index 000000000000..8042e5ebc778 --- /dev/null +++ b/website/content/bot/reference/discord/screeners/index.mdx @@ -0,0 +1,37 @@ +# screeners + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/discord/short_data/index.mdx b/website/content/bot/reference/discord/short_data/index.mdx new file mode 100644 index 000000000000..e0316f824048 --- /dev/null +++ b/website/content/bot/reference/discord/short_data/index.mdx @@ -0,0 +1,32 @@ +# short_data + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/generate_index.py b/website/content/bot/reference/generate_index.py index b02eac13d575..fdd0e2e41b4e 100644 --- a/website/content/bot/reference/generate_index.py +++ b/website/content/bot/reference/generate_index.py @@ -1,85 +1,84 @@ -# import re -# from pathlib import Path -# from textwrap import shorten -# from typing import Dict, List - -# reference_import = """import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -# \n") - -# with open(Path(__file__).parent / bot / "index.mdx", "w", **wopen_kwargs) as index: # type: ignore -# index.write(f"# OpenBB {bot.title()} Reference\n\n{reference_import}\n") - -# for folder in (Path(__file__).parent / bot).glob("*"): -# if not folder.is_dir(): -# continue - -# index.write(create_nested_subfolder_card(folder, bot)) -# index.write("\n") +import re +from pathlib import Path +from textwrap import shorten +from typing import Dict, List + +reference_import = """import ReferenceCard from "@site/src/components/General/ReferenceCard"; + +\n") + + with open(Path(__file__).parent / bot / "index.mdx", "w", **wopen_kwargs) as index: # type: ignore + index.write(f"# OpenBB {bot.title()} Reference\n\n{reference_import}\n") + + for folder in (Path(__file__).parent / bot).glob("*"): + if not folder.is_dir(): + continue + + index.write(create_nested_subfolder_card(folder, bot)) + index.write("\n") diff --git a/website/content/bot/reference/telegram/charts/index.mdx b/website/content/bot/reference/telegram/charts/index.mdx new file mode 100644 index 000000000000..7d2015206dfd --- /dev/null +++ b/website/content/bot/reference/telegram/charts/index.mdx @@ -0,0 +1,62 @@ +# charts + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/crypto/index.mdx b/website/content/bot/reference/telegram/crypto/index.mdx new file mode 100644 index 000000000000..0f06daffffa5 --- /dev/null +++ b/website/content/bot/reference/telegram/crypto/index.mdx @@ -0,0 +1,52 @@ +# crypto + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/darkpool/index.mdx b/website/content/bot/reference/telegram/darkpool/index.mdx new file mode 100644 index 000000000000..d9ef10368d25 --- /dev/null +++ b/website/content/bot/reference/telegram/darkpool/index.mdx @@ -0,0 +1,47 @@ +# darkpool + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/discovery/index.mdx b/website/content/bot/reference/telegram/discovery/index.mdx new file mode 100644 index 000000000000..e81b8988de73 --- /dev/null +++ b/website/content/bot/reference/telegram/discovery/index.mdx @@ -0,0 +1,47 @@ +# discovery + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/duediligence/index.mdx b/website/content/bot/reference/telegram/duediligence/index.mdx new file mode 100644 index 000000000000..72b972d1da4f --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/index.mdx @@ -0,0 +1,92 @@ +# duediligence + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/economy/index.mdx b/website/content/bot/reference/telegram/economy/index.mdx new file mode 100644 index 000000000000..ddb84ef68c6f --- /dev/null +++ b/website/content/bot/reference/telegram/economy/index.mdx @@ -0,0 +1,47 @@ +# economy + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/etf/index.mdx b/website/content/bot/reference/telegram/etf/index.mdx new file mode 100644 index 000000000000..f3acfd72d7c6 --- /dev/null +++ b/website/content/bot/reference/telegram/etf/index.mdx @@ -0,0 +1,17 @@ +# etf + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/flow/index.mdx b/website/content/bot/reference/telegram/flow/index.mdx new file mode 100644 index 000000000000..e2d61c2823f9 --- /dev/null +++ b/website/content/bot/reference/telegram/flow/index.mdx @@ -0,0 +1,32 @@ +# flow + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/fun/index.mdx b/website/content/bot/reference/telegram/fun/index.mdx new file mode 100644 index 000000000000..5bc15dce8ed3 --- /dev/null +++ b/website/content/bot/reference/telegram/fun/index.mdx @@ -0,0 +1,22 @@ +# fun + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/general/index.mdx b/website/content/bot/reference/telegram/general/index.mdx new file mode 100644 index 000000000000..4982c6e6c950 --- /dev/null +++ b/website/content/bot/reference/telegram/general/index.mdx @@ -0,0 +1,27 @@ +# general + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/government/index.mdx b/website/content/bot/reference/telegram/government/index.mdx new file mode 100644 index 000000000000..445f5cb2d96e --- /dev/null +++ b/website/content/bot/reference/telegram/government/index.mdx @@ -0,0 +1,22 @@ +# government + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/index.mdx b/website/content/bot/reference/telegram/index.mdx new file mode 100644 index 000000000000..916c0898c12a --- /dev/null +++ b/website/content/bot/reference/telegram/index.mdx @@ -0,0 +1,92 @@ +# OpenBB Telegram Reference + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/info/index.mdx b/website/content/bot/reference/telegram/info/index.mdx new file mode 100644 index 000000000000..9165a8b304dd --- /dev/null +++ b/website/content/bot/reference/telegram/info/index.mdx @@ -0,0 +1,17 @@ +# info + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/nft/index.mdx b/website/content/bot/reference/telegram/nft/index.mdx new file mode 100644 index 000000000000..430620379149 --- /dev/null +++ b/website/content/bot/reference/telegram/nft/index.mdx @@ -0,0 +1,17 @@ +# nft + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/options/index.mdx b/website/content/bot/reference/telegram/options/index.mdx new file mode 100644 index 000000000000..2554d830cf5c --- /dev/null +++ b/website/content/bot/reference/telegram/options/index.mdx @@ -0,0 +1,117 @@ +# options + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/overview/index.mdx b/website/content/bot/reference/telegram/overview/index.mdx new file mode 100644 index 000000000000..828ad3baedb4 --- /dev/null +++ b/website/content/bot/reference/telegram/overview/index.mdx @@ -0,0 +1,37 @@ +# overview + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/screeners/index.mdx b/website/content/bot/reference/telegram/screeners/index.mdx new file mode 100644 index 000000000000..dbb8e33af05e --- /dev/null +++ b/website/content/bot/reference/telegram/screeners/index.mdx @@ -0,0 +1,17 @@ +# screeners + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + + diff --git a/website/content/bot/reference/telegram/short_data/index.mdx b/website/content/bot/reference/telegram/short_data/index.mdx new file mode 100644 index 000000000000..c246d06b2705 --- /dev/null +++ b/website/content/bot/reference/telegram/short_data/index.mdx @@ -0,0 +1,32 @@ +# short_data + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + +