summaryrefslogtreecommitdiffstats
path: root/Python/Dependencies/future-0.18.2/docs/reference.rst
diff options
context:
space:
mode:
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