.. TypeWrap documentation master file, created by sphinx-quickstart on Mon Nov 9 10:36:18 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to TypeWrap's documentation! ==================================== .. toctree:: :maxdepth: 4 :caption: Contents: typewrap *created by Austin Poor* .. image:: https://travis-ci.com/a-poor/typewrap.svg?branch=master :target: https://travis-ci.com/a-poor/typewrap .. image:: https://img.shields.io/pypi/v/typewrap :target: https://pypi.org/project/typewrap .. image:: https://img.shields.io/pypi/pyversions/typewrap :target: https://pypi.org/project/typewrap .. image:: https://codecov.io/gh/a-poor/typewrap/branch/master/graph/badge.svg :target: https://codecov.io/gh/a-poor/typewrap .. image:: https://readthedocs.org/projects/typewrap/badge/?version=latest :target: https://typewrap.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status A super tiny python package for function typechecking. * GitHub: https://github.com/a-poor/typewrap * ReadTheDocs: https://typewrap.readthedocs.io * PyPi: https://pypi.org/project/typewrap Requirements ------------- * ``python>=3.6`` Installation ------------- Installing with ``pip``: .. code-block:: console $ pip install typewrap Usage ----- .. automodule:: typewrap :noindex: :members: :undoc-members: :show-inheritance: Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`