summaryrefslogtreecommitdiffstats
path: root/Python/Dependencies/future-0.18.2/docs/reference.rst
diff options
context:
space:
mode:
authoryum <yum.food.vr@gmail.com>2022-12-17 17:26:16 -0800
committeryum <yum.food.vr@gmail.com>2022-12-17 17:26:16 -0800
commit4d836989720523cd0363927e3e066f56b9dc445c (patch)
treef7a9ff7cb50eda1ff29e91c78067dcc5e0ce6233 /Python/Dependencies/future-0.18.2/docs/reference.rst
parentda754e9cf5b192239826aa1619e1ada3c98daa45 (diff)
Check in `future` package
I hit some issues installing Whisper and had to embed this package. I haven't taken the time to deeply understand what's going on. I think that embedded Python follows different rules about resolving module paths than regular system Python. Basically, `future`'s setup.py has a line like `import src`, where `src` is a module inside future (like `future/src/__init__.py`). This doesn't work unless we put that directory on the search path.
Diffstat (limited to 'Python/Dependencies/future-0.18.2/docs/reference.rst')
-rw-r--r--Python/Dependencies/future-0.18.2/docs/reference.rst81
1 files changed, 81 insertions, 0 deletions
diff --git a/Python/Dependencies/future-0.18.2/docs/reference.rst b/Python/Dependencies/future-0.18.2/docs/reference.rst
new file mode 100644
index 0000000..d9ac5e1
--- /dev/null
+++ b/Python/Dependencies/future-0.18.2/docs/reference.rst
@@ -0,0 +1,81 @@
+API Reference (in progress)
+***************************
+
+**NOTE: This page is still a work in progress... We need to go through our
+docstrings and make them sphinx-compliant, and figure out how to improve
+formatting with the sphinx-bootstrap-theme plugin. Pull requests would be
+very welcome.**
+
+
+.. contents::
+ :local:
+ :depth: 2
+
+future.builtins Interface
+=========================
+
+.. automodule:: future.builtins
+ :members:
+
+.. Docs are also in future-builtins.rst. Extract these and put them into the
+.. relevant docstrings.
+
+
+Backported types from Python 3
+==============================
+
+.. automodule:: future.types
+ :members:
+
+
+future.standard_library Interface
+=================================
+
+.. automodule:: future.standard_library
+ :members:
+
+
+future.utils Interface
+======================
+
+.. automodule:: future.utils
+ :members:
+
+
+past.builtins Interface
+=========================
+
+.. automodule:: past.builtins
+ :members:
+
+.. Docs are also in future-builtins.rst. Extract these and put them into the
+.. relevant docstrings.
+
+
+Forward-ported types from Python 2
+==================================
+
+.. automodule:: past.types
+ :members:
+
+
+
+.. bytes
+.. -----
+.. .. automodule:: future.types.newbytes
+..
+.. dict
+.. -----
+.. .. automodule:: future.types.newdict
+..
+.. int
+.. ---
+.. .. automodule:: future.builtins.backports.newint
+..
+.. range
+.. -----
+.. .. automodule:: future.types.newrange
+..
+.. str
+.. ---
+.. .. automodule:: future.types.newstr