Add documentation

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,61 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("."))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "py-libp2p"
+copyright = "2019, The py-libp2p team"
+author = "The py-libp2p team"
+
+# The full version, including alpha/beta/rc tags
+release = "0.1.1"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.coverage",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]

docs/source/index.rst

@@ -0,0 +1,17 @@
+Welcome to py-libp2p's documentation!
+=====================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   installation
+   libp2p/index.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/installation.rst

@@ -0,0 +1,50 @@
+.. highlight:: shell
+
+Installation
+============
+
+Stable release
+--------------
+
+To install :code:`py-libp2p`:, run this command in your terminal:
+
+.. code-block:: console
+
+    $ pip install libp2p
+
+This is the preferred method to install the library, as it will always install
+the most recent stable release.
+
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
+
+.. _pip: https://pip.pypa.io
+.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+
+
+From sources
+------------
+
+The sources for :code:`py-libp2p` can be downloaded from the `Github repo`_.
+
+You can either clone the public repository:
+
+.. code-block:: console
+
+    $ git clone git://github.com/libp2p/py-libp2p
+
+Or download the `tarball`_:
+
+.. code-block:: console
+
+    $ curl  -OL https://github.com/libp2p/py-libp2p/tarball/master
+
+Once you have a copy of the source, you can install it with:
+
+.. code-block:: console
+
+    $ python setup.py install
+
+
+.. _Github repo: https://github.com/libp2p/py-libp2p
+.. _tarball: https://github.com/libp2p/py-libp2p/tarball/master

docs/source/libp2p/crypto/authenticated_encryption.rst

@@ -0,0 +1,7 @@
+libp2p.crypto.authenticated_encryption
+======================================
+
+.. automodule:: libp2p.crypto.authenticated_encryption
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/crypto/ecc.rst

@@ -0,0 +1,7 @@
+libp2p.crypto.ecc
+=================
+
+.. automodule:: libp2p.crypto.ecc
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/crypto/ed25519.rst

@@ -0,0 +1,7 @@
+libp2p.crypto.ed25519
+======================
+
+.. automodule:: libp2p.crypto.ed25519
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/crypto/exceptions.rst

@@ -0,0 +1,7 @@
+libp2p.crypto.exceptions
+========================
+
+.. automodule:: libp2p.crypto.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/crypto/index.rst

@@ -0,0 +1,14 @@
+libp2p.crypto
+=============
+
+.. toctree::
+    authenticated_encryption.rst
+    ecc.rst
+    ed25519.rst
+    exceptions.rst
+    key_exchange.rst
+    keys.rst
+    rsa.rst
+    secp256k1.rst
+    serialization.rst
+    pb/crypto_pb2.rst

docs/source/libp2p/crypto/key_exchange.rst

@@ -0,0 +1,7 @@
+libp2p.crypto.key_exchange
+==========================
+
+.. automodule:: libp2p.crypto.key_exchange
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/crypto/keys.rst

@@ -0,0 +1,7 @@
+libp2p.crypto.keys
+==================
+
+.. automodule:: libp2p.crypto.keys
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/crypto/pb/crypto_pb2.rst

@@ -0,0 +1,7 @@
+libp2p.crypto.pb.crypto_pb2
+===========================
+
+.. automodule:: libp2p.crypto.pb.crypto_pb2
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/crypto/rsa.rst

@@ -0,0 +1,7 @@
+libp2p.crypto.rsa
+=================
+
+.. automodule:: libp2p.crypto.rsa
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/crypto/secp256k1.rst

@@ -0,0 +1,7 @@
+libp2p.crypto.secp256k1
+=======================
+
+.. automodule:: libp2p.crypto.secp256k1
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/crypto/serialization.rst

@@ -0,0 +1,7 @@
+libp2p.crypto.serialization
+===========================
+
+.. automodule:: libp2p.crypto.serialization
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/exceptions.rst

@@ -0,0 +1,7 @@
+libp2p.exceptions
+=================
+
+.. automodule:: libp2p.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/host/basic_host.rst

@@ -0,0 +1,7 @@
+libp2p.host.basic_host
+======================
+
+.. automodule:: libp2p.host.basic_host
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/host/exceptions.rst

@@ -0,0 +1,7 @@
+libp2p.host.exceptions
+======================
+
+.. automodule:: libp2p.host.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/host/host_interface.rst

@@ -0,0 +1,7 @@
+libp2p.host.host_interface
+==========================
+
+.. automodule:: libp2p.host.host_interface
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/host/index.rst

@@ -0,0 +1,8 @@
+libp2p.host
+===========
+
+.. toctree::
+    basic_host.rst
+    exceptions.rst
+    host_interface.rst
+    routed_host.rst

docs/source/libp2p/host/routed_host.rst

@@ -0,0 +1,7 @@
+libp2p.host.routed_host
+=======================
+
+.. automodule:: libp2p.host.routed_host
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/index.rst

@@ -0,0 +1,21 @@
+libp2p module
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+    crypto/index.rst
+    host/index.rst
+    io/index.rst
+    kademlia/index.rst
+    network/index.rst
+    peer/index.rst
+    protocol_muxer/index.rst
+    pubsub/index.rst
+    routing/index.rst
+    security/index.rst
+    stream_muxer/index.rst
+    transport/index.rst
+    exceptions.rst
+    typing.rst

docs/source/libp2p/io/abc.rst

@@ -0,0 +1,7 @@
+libp2p.io.abc
+=============
+
+.. automodule:: libp2p.io.abc
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/io/exceptions.rst

@@ -0,0 +1,7 @@
+libp2p.io.exceptions
+====================
+
+.. automodule:: libp2p.io.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/io/index.rst

@@ -0,0 +1,8 @@
+libp2p.io
+=========
+
+.. toctree::
+    abc.rst
+    exceptions.rst
+    msgio.rst
+    utils.rst

docs/source/libp2p/io/msgio.rst

@@ -0,0 +1,7 @@
+libp2p.io.msgio
+===============
+
+.. automodule:: libp2p.io.msgio
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/libp2p/io/utils.rst

@@ -0,0 +1,7 @@
+libp2p.io.utils
+===============
+
+.. automodule:: libp2p.io.utils
+    :members:
+    :undoc-members:
+    :show-inheritance: