valemobil/python-future: Easy, clean, reliable Python 2/3 compatibility

docs/reference.rst

60 строк1 KB

Ed Schofield

Add a note on pow() to the docs

28 янв 2014, 04:58

28 янв 2014, 04:580bccf34

#############
API Reference
#############

*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.


future.standard_library Interface
=================================

.. automodule:: future.standard_library
    :members:


future.utils Interface
======================

.. automodule:: future.utils
    :members:


Backported types
================

bytes
-----
.. automodule:: future.builtins.types.newbytes

dict
-----
.. automodule:: future.builtins.types.newdict

int
---
.. automodule:: future.builtins.backports.newint

range
-----
.. automodule:: future.builtins.types.newrange

str
---
.. automodule:: future.builtins.types.newstr