dev(narugo): add docs for hfutils.utils.session

deepghs · Aug 9, 2024 · ced5b21 · ced5b21
1 parent 1ead25d
commit ced5b21
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/docs/source/api_doc/utils/index.rst b/docs/source/api_doc/utils/index.rst
@@ -13,6 +13,7 @@ hfutils.utils
     download
     number
     path
+    session
     tqdm_
     walk
 
diff --git a/docs/source/api_doc/utils/session.rst b/docs/source/api_doc/utils/session.rst
@@ -0,0 +1,31 @@
+hfutils.utils.session
+=================================
+
+.. currentmodule:: hfutils.utils.session
+
+.. automodule:: hfutils.utils.session
+
+
+
+TimeoutHTTPAdapter
+-----------------------------------------------------
+
+.. autoclass:: TimeoutHTTPAdapter
+    :members: __init__, send
+
+
+
+get_requests_session
+-----------------------------------------------------
+
+.. autofunction:: get_requests_session
+
+
+
+get_random_ua
+-----------------------------------------------------
+
+.. autofunction:: get_random_ua
+
+
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,7 @@ hfutils.utils @@
         download
         number
         path
+        session
         tqdm_
         walk