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

docs/reference.rst

40 строк801 B

Ed Schofield

Update docs: use sphinx-bootstrap and include basic auto-generated API docs

14 ноя 2013, 16:25

14 ноя 2013, 16:25e0c4734

###############
Reference Guide
###############

.. *NOTE: These are 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.*


.. contents::
    :local:
    :depth: 2

future.builtins Interface
============================

.. automodule:: future.builtins
    :members:


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

.. automodule:: future.standard_library
    :members:


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

.. automodule:: future.utils
    :members:


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

.. autoclass:: future.builtins.backports.newbytes
.. autoclass:: future.builtins.backports.newstr
.. autoclass:: future.builtins.backports.newint