DOCS

ranaroussi · Jan 10, 2025 · fb122c0 · fb122c0
1 parent 54fd605
commit fb122c0
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/doc/source/advanced/config.rst 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.
diff --git a/doc/source/advanced/index.rst b/doc/source/advanced/index.rst
@@ -8,4 +8,5 @@ Advanced
    logging
    proxy
    caching
-   multi_level_columns
+   multi_level_columns
+   config
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,4 +8,5 @@ Advanced @@
        logging
        proxy
        caching
-       multi_level_columns
+       multi_level_columns
+       config