From fb122c0d1211f123807e138c758e6f6bc6dbb876 Mon Sep 17 00:00:00 2001 From: R5dan Date: Fri, 10 Jan 2025 10:56:16 +0000 Subject: [PATCH] DOCS --- doc/source/advanced/config.rst | 20 ++++++++++++++++++++ doc/source/advanced/index.rst | 3 ++- 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 doc/source/advanced/config.rst diff --git a/doc/source/advanced/config.rst b/doc/source/advanced/config.rst new file mode 100644 index 00000000..884357d3 --- /dev/null +++ b/doc/source/advanced/config.rst @@ -0,0 +1,20 @@ +====== +Config +====== + +`yfinance` allows you to set configurations for requests. + +You can set: +* proxy +* timeout +* lang +* region +* session +* url + +.. code-block:: python + + yf.set_config(proxy=None, timeout=30, lang="en-US", region="US", session=None, url="finance.yahoo.com") + +.. important:: + DO NOT ADD `https://` to start of url. This will cause an error. \ No newline at end of file diff --git a/doc/source/advanced/index.rst b/doc/source/advanced/index.rst index e1612ccf..e5f0792c 100644 --- a/doc/source/advanced/index.rst +++ b/doc/source/advanced/index.rst @@ -8,4 +8,5 @@ Advanced logging proxy caching - multi_level_columns \ No newline at end of file + multi_level_columns + config \ No newline at end of file