.. _index:

==================================
Welcome to pyroxy's documentation!
==================================

.. include:: ../README.rst

.. warning::

    Currently, :mod:`pyroxy` only supports locally available PyPI
    repositories, which means you'll need to have a mirror of PyPI, ala
    :pep:`381`.  This will definitely change in the future.

=======================
Narrative Documentation
=======================

.. toctree::
    :maxdepth: 1
    :glob:

    narr/getting_started
    narr/configuration
    narr/troubleshooting

=============
API Reference
=============

.. toctree::
    :maxdepth: 1
    :glob:

    api/*

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

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