i2plib/docs/index.rst

41 lines
928 B
ReStructuredText

.. i2plib documentation master file, created by
sphinx-quickstart on Wed Sep 5 07:52:14 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to i2plib's documentation!
==================================
i2plib is a modern asynchronous library for building I2P applications.
Requirements:
- Python version >= 3.5
- I2P router with SAM API enabled
.. toctree::
:maxdepth: 2
:caption: Contents:
quickstart
api
External links
--------------
* `Invisible Internet Project`_
* `SAM API documentation`_
* `Python asyncio documentation`_
.. _Invisible Internet Project: https://geti2p.net/en/
.. _SAM API documentation: https://geti2p.net/en/docs/api/samv3
.. _Python asyncio documentation: https://docs.python.org/3/library/asyncio.html
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`