.. TRAW documentation master file, created by
   sphinx-quickstart on Tue Aug  8 14:11:40 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to TRAW's documentation!
================================

:pypi:`TRAW`, the TestRail Api Wrapper, aims to be a feature complete python
interface to TestRail's RESTful API.

Contents
--------

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   quick-reference
   credentials
   adding-updating

.. seealso::

    * `TRAW Examples`_: TRAW examples scripts

.. _TRAW Examples: https://github.com/levi-rs/traw/tree/master/examples



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`