mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 04:52:07 +00:00
cd420c51c7
* example changes in slopes * change lettering size and side bar capitalization * revert back to Fira * start automatic website generation * this was autogen * add examples to slopes model * generate slopes doc * change to _index.md * allow italic formatting * fix regex * option to regenerate paths * update alt docs * fix generate * update alt * fix generate * update common * target italic only for types * format alt * format italic common * add sig indentation * update sig indent alt * update common ident * add todo * generate docstrings for all menus * fix maxdd * fix returns font size * fix keys docs * fix more docstrings * escape literal symbols * escape literal symbols * reformat keys * format opt * remove literal escape * remove another literal escape * remove another literal escape * unindent returns * update docs return unindent * add comma in last arg * fix funcs without params * fix signature * compact some code * refactor some more code * refactor some code * some final cleanup * write docstrings * change main * move futures paths * generate futures docs * add external axes references * fix typo * revert to double docstring * fix small bug * remove docs folder * generate.py in website folder * add forecast to docs * clear some warnings * fix underscore * remove cite * refresh website docs * fix forecast docstrings * fix po * fix po docs and remove italic * fix more docstrings * remove last warning * codespell * flake8 * exclude website contente from flake * noqa on optimizer * update website * fix mypy * remove setup from mypy * mypy to openbbterminal * update precommit * pylint * try to remove sdk loading issue * avoid logging on test Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
96 lines
3.7 KiB
TOML
Vendored
96 lines
3.7 KiB
TOML
Vendored
baseURL = "https://openbb-finance.github.io/OpenBBTerminal"
|
|
theme = "hugo-geekdoc"
|
|
title = "OpenBB Terminal Documentation"
|
|
|
|
# Required to get well formatted code blocks
|
|
pygmentsUseClasses = true
|
|
pygmentsCodeFences = true
|
|
disablePathToLower = true
|
|
enableGitInfo = true
|
|
|
|
[markup]
|
|
[markup.goldmark.renderer]
|
|
# Needed for mermaid shortcode
|
|
unsafe = true
|
|
[markup.tableOfContents]
|
|
startLevel = 1
|
|
endLevel = 9
|
|
|
|
[params]
|
|
# (Optional, default 6) Set how many table of contents levels to be showed on page.
|
|
# Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
|
|
# You can also specify this parameter per page in front matter.
|
|
geekdocToC = 1
|
|
|
|
# (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc
|
|
# relative to your 'static/' folder.
|
|
geekdocLogo = "openbb_logo.svg"
|
|
|
|
# (Optional, default false) Render menu from data file in 'data/menu/main.yaml'.
|
|
geekdocMenuBundle = true
|
|
|
|
# (Optional, default true) Show page navigation links at the bottom of each
|
|
# docs page (bundle menu only).
|
|
geekdocNextPrev = true
|
|
|
|
# (Optional, default true) Show a breadcrumb navigation bar at the top of each docs page.
|
|
# You can also specify this parameter per page in front matter.
|
|
geekdocBreadcrumb = true
|
|
|
|
# (Optional, default none) Set source repository location. Used for 'Edit this page' links.
|
|
# You can also specify this parameter per page in front matter.
|
|
geekdocRepo = "https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/website"
|
|
|
|
# (Optional, default none) Enable 'Edit this page' links. Requires 'GeekdocRepo' param
|
|
# and path must point to 'content' directory of repo.
|
|
# You can also specify this parameter per page in front matter.
|
|
geekdocEditPath = "/content"
|
|
|
|
# (Optional, default true) Enables search function with flexsearch.
|
|
# Index is built on the fly and might slowdown your website.
|
|
geekdocSearch = true
|
|
|
|
# (Optional, default false) Display search results with the parent folder as prefix. This
|
|
# option allows you to distinguish between files with the same name in different folders.
|
|
# NOTE: This parameter only applies when 'geekdocSearch = true'.
|
|
geekdocSearchShowParent = true
|
|
|
|
# (Optional, default none) Add a link to your Legal Notice page to the site footer.
|
|
# It can be either a remote url or a local file path relative to your content directory.
|
|
#geekdocLegalNotice = "https://blog.example.com/legal"
|
|
|
|
# (Optional, default none) Add a link to your Privacy Policy page to the site footer.
|
|
# It can be either a remote url or a local file path relative to your content directory.
|
|
#geekdocPrivacyPolicy = "/privacy"
|
|
|
|
# (Optional, default true) Add an anchor link to headlines.
|
|
geekdocAnchor = true
|
|
|
|
# (Optional, default true) Copy anchor url to clipboard on click.
|
|
geekdocAnchorCopy = true
|
|
|
|
# (Optional, default true) Enable or disable image lazy loading for images rendered
|
|
# by the 'img' shortcode.
|
|
geekdocImageLazyLoading = true
|
|
|
|
# (Optional, default false) Set HTMl <base> to .Site.BaseURL if enabled. It might be required
|
|
# if a subdirectory is used within Hugos BaseURL.
|
|
# See https://developer.mozilla.org/de/docs/Web/HTML/Element/base.
|
|
geekdocOverwriteHTMLBase = false
|
|
|
|
# (Optional, default false) Auto-decrease brightness of images and add a slightly grayscale to avoid
|
|
# bright spots while using the dark mode.
|
|
geekdocDarkModeDim = false
|
|
|
|
|
|
[security]
|
|
enableInlineShortcodes = false
|
|
[security.exec]
|
|
allow = ['^dart-sass-embedded$', '^go$', '^npx$', '^postcss$', "rst2html.py"]
|
|
osEnv = ['(?i)^((HTTPS?|NO)_PROXY|PATH(EXT)?|APPDATA|TE?MP|TERM)$']
|
|
[security.funcs]
|
|
getenv = ['^HUGO_']
|
|
[security.http]
|
|
methods = ['(?i)GET|POST']
|
|
urls = ['.*']
|