diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..d0c3cbf1 --- /dev/null +++ b/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) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..6247f7e2 --- /dev/null +++ b/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 diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 00000000..ee781cac --- /dev/null +++ b/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"] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..7561f735 --- /dev/null +++ b/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` diff --git a/docs/source/installation.rst b/docs/source/installation.rst new file mode 100644 index 00000000..2ad6328d --- /dev/null +++ b/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 diff --git a/docs/source/libp2p/crypto/authenticated_encryption.rst b/docs/source/libp2p/crypto/authenticated_encryption.rst new file mode 100644 index 00000000..f1ca155f --- /dev/null +++ b/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: diff --git a/docs/source/libp2p/crypto/ecc.rst b/docs/source/libp2p/crypto/ecc.rst new file mode 100644 index 00000000..77a50b84 --- /dev/null +++ b/docs/source/libp2p/crypto/ecc.rst @@ -0,0 +1,7 @@ +libp2p.crypto.ecc +================= + +.. automodule:: libp2p.crypto.ecc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/crypto/ed25519.rst b/docs/source/libp2p/crypto/ed25519.rst new file mode 100644 index 00000000..1b23bef9 --- /dev/null +++ b/docs/source/libp2p/crypto/ed25519.rst @@ -0,0 +1,7 @@ +libp2p.crypto.ed25519 +====================== + +.. automodule:: libp2p.crypto.ed25519 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/crypto/exceptions.rst b/docs/source/libp2p/crypto/exceptions.rst new file mode 100644 index 00000000..a39b151e --- /dev/null +++ b/docs/source/libp2p/crypto/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.crypto.exceptions +======================== + +.. automodule:: libp2p.crypto.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/crypto/index.rst b/docs/source/libp2p/crypto/index.rst new file mode 100644 index 00000000..93addacc --- /dev/null +++ b/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 diff --git a/docs/source/libp2p/crypto/key_exchange.rst b/docs/source/libp2p/crypto/key_exchange.rst new file mode 100644 index 00000000..9cc5e2ce --- /dev/null +++ b/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: diff --git a/docs/source/libp2p/crypto/keys.rst b/docs/source/libp2p/crypto/keys.rst new file mode 100644 index 00000000..e09a8b0a --- /dev/null +++ b/docs/source/libp2p/crypto/keys.rst @@ -0,0 +1,7 @@ +libp2p.crypto.keys +================== + +.. automodule:: libp2p.crypto.keys + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/crypto/pb/crypto_pb2.rst b/docs/source/libp2p/crypto/pb/crypto_pb2.rst new file mode 100644 index 00000000..42eaad58 --- /dev/null +++ b/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: diff --git a/docs/source/libp2p/crypto/rsa.rst b/docs/source/libp2p/crypto/rsa.rst new file mode 100644 index 00000000..d3ef1cf1 --- /dev/null +++ b/docs/source/libp2p/crypto/rsa.rst @@ -0,0 +1,7 @@ +libp2p.crypto.rsa +================= + +.. automodule:: libp2p.crypto.rsa + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/crypto/secp256k1.rst b/docs/source/libp2p/crypto/secp256k1.rst new file mode 100644 index 00000000..28624e1b --- /dev/null +++ b/docs/source/libp2p/crypto/secp256k1.rst @@ -0,0 +1,7 @@ +libp2p.crypto.secp256k1 +======================= + +.. automodule:: libp2p.crypto.secp256k1 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/crypto/serialization.rst b/docs/source/libp2p/crypto/serialization.rst new file mode 100644 index 00000000..cd010275 --- /dev/null +++ b/docs/source/libp2p/crypto/serialization.rst @@ -0,0 +1,7 @@ +libp2p.crypto.serialization +=========================== + +.. automodule:: libp2p.crypto.serialization + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/exceptions.rst b/docs/source/libp2p/exceptions.rst new file mode 100644 index 00000000..c84aca36 --- /dev/null +++ b/docs/source/libp2p/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.exceptions +================= + +.. automodule:: libp2p.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/host/basic_host.rst b/docs/source/libp2p/host/basic_host.rst new file mode 100644 index 00000000..b68a534c --- /dev/null +++ b/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: diff --git a/docs/source/libp2p/host/exceptions.rst b/docs/source/libp2p/host/exceptions.rst new file mode 100644 index 00000000..e6f45f9a --- /dev/null +++ b/docs/source/libp2p/host/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.host.exceptions +====================== + +.. automodule:: libp2p.host.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/host/host_interface.rst b/docs/source/libp2p/host/host_interface.rst new file mode 100644 index 00000000..801e66e3 --- /dev/null +++ b/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: diff --git a/docs/source/libp2p/host/index.rst b/docs/source/libp2p/host/index.rst new file mode 100644 index 00000000..ae490e33 --- /dev/null +++ b/docs/source/libp2p/host/index.rst @@ -0,0 +1,8 @@ +libp2p.host +=========== + +.. toctree:: + basic_host.rst + exceptions.rst + host_interface.rst + routed_host.rst diff --git a/docs/source/libp2p/host/routed_host.rst b/docs/source/libp2p/host/routed_host.rst new file mode 100644 index 00000000..34342427 --- /dev/null +++ b/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: diff --git a/docs/source/libp2p/index.rst b/docs/source/libp2p/index.rst new file mode 100644 index 00000000..8bfba673 --- /dev/null +++ b/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 diff --git a/docs/source/libp2p/io/abc.rst b/docs/source/libp2p/io/abc.rst new file mode 100644 index 00000000..f7178145 --- /dev/null +++ b/docs/source/libp2p/io/abc.rst @@ -0,0 +1,7 @@ +libp2p.io.abc +============= + +.. automodule:: libp2p.io.abc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/io/exceptions.rst b/docs/source/libp2p/io/exceptions.rst new file mode 100644 index 00000000..6e410f9b --- /dev/null +++ b/docs/source/libp2p/io/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.io.exceptions +==================== + +.. automodule:: libp2p.io.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/io/index.rst b/docs/source/libp2p/io/index.rst new file mode 100644 index 00000000..85bc8dfc --- /dev/null +++ b/docs/source/libp2p/io/index.rst @@ -0,0 +1,8 @@ +libp2p.io +========= + +.. toctree:: + abc.rst + exceptions.rst + msgio.rst + utils.rst diff --git a/docs/source/libp2p/io/msgio.rst b/docs/source/libp2p/io/msgio.rst new file mode 100644 index 00000000..886ed1f9 --- /dev/null +++ b/docs/source/libp2p/io/msgio.rst @@ -0,0 +1,7 @@ +libp2p.io.msgio +=============== + +.. automodule:: libp2p.io.msgio + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/io/utils.rst b/docs/source/libp2p/io/utils.rst new file mode 100644 index 00000000..f78410cd --- /dev/null +++ b/docs/source/libp2p/io/utils.rst @@ -0,0 +1,7 @@ +libp2p.io.utils +=============== + +.. automodule:: libp2p.io.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/kademlia/crawling.rst b/docs/source/libp2p/kademlia/crawling.rst new file mode 100644 index 00000000..07741d05 --- /dev/null +++ b/docs/source/libp2p/kademlia/crawling.rst @@ -0,0 +1,7 @@ +libp2p.kademlia.crawling +======================== + +.. automodule:: libp2p.kademlia.crawling + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/kademlia/index.rst b/docs/source/libp2p/kademlia/index.rst new file mode 100644 index 00000000..4119d731 --- /dev/null +++ b/docs/source/libp2p/kademlia/index.rst @@ -0,0 +1,11 @@ +libp2p.kademlia +=============== + +.. toctree:: + crawling.rst + kad_peerinfo.rst + network.rst + protocol.rst + routing.rst + storage.rst + utils.rst diff --git a/docs/source/libp2p/kademlia/kad_peerinfo.rst b/docs/source/libp2p/kademlia/kad_peerinfo.rst new file mode 100644 index 00000000..7e73d768 --- /dev/null +++ b/docs/source/libp2p/kademlia/kad_peerinfo.rst @@ -0,0 +1,7 @@ +libp2p.kademlia.kad_peerinfo +============================ + +.. automodule:: libp2p.kademlia.kad_peerinfo + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/kademlia/network.rst b/docs/source/libp2p/kademlia/network.rst new file mode 100644 index 00000000..74cfd02a --- /dev/null +++ b/docs/source/libp2p/kademlia/network.rst @@ -0,0 +1,7 @@ +libp2p.kademlia.network +======================= + +.. automodule:: libp2p.kademlia.network + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/kademlia/protocol.rst b/docs/source/libp2p/kademlia/protocol.rst new file mode 100644 index 00000000..7cf180ee --- /dev/null +++ b/docs/source/libp2p/kademlia/protocol.rst @@ -0,0 +1,7 @@ +libp2p.kademlia.protocol +======================== + +.. automodule:: libp2p.kademlia.protocol + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/kademlia/routing.rst b/docs/source/libp2p/kademlia/routing.rst new file mode 100644 index 00000000..0384f1b8 --- /dev/null +++ b/docs/source/libp2p/kademlia/routing.rst @@ -0,0 +1,7 @@ +libp2p.kademlia.routing +======================= + +.. automodule:: libp2p.kademlia.routing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/kademlia/storage.rst b/docs/source/libp2p/kademlia/storage.rst new file mode 100644 index 00000000..c6f8ca83 --- /dev/null +++ b/docs/source/libp2p/kademlia/storage.rst @@ -0,0 +1,7 @@ +libp2p.kademlia.storage +======================= + +.. automodule:: libp2p.kademlia.storage + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/kademlia/utils.rst b/docs/source/libp2p/kademlia/utils.rst new file mode 100644 index 00000000..820eaa37 --- /dev/null +++ b/docs/source/libp2p/kademlia/utils.rst @@ -0,0 +1,7 @@ +libp2p.kademlia.utils +===================== + +.. automodule:: libp2p.kademlia.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/connection/exceptions.rst b/docs/source/libp2p/network/connection/exceptions.rst new file mode 100644 index 00000000..395ed099 --- /dev/null +++ b/docs/source/libp2p/network/connection/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.network.connection.exceptions +==================================== + +.. automodule:: libp2p.network.connection.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/connection/net_connection_interface.rst b/docs/source/libp2p/network/connection/net_connection_interface.rst new file mode 100644 index 00000000..78bb2394 --- /dev/null +++ b/docs/source/libp2p/network/connection/net_connection_interface.rst @@ -0,0 +1,7 @@ +libp2p.network.connection.net_connection_interface +================================================== + +.. automodule:: libp2p.network.connection.net_connection_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/connection/raw_connection.rst b/docs/source/libp2p/network/connection/raw_connection.rst new file mode 100644 index 00000000..23a6bbf6 --- /dev/null +++ b/docs/source/libp2p/network/connection/raw_connection.rst @@ -0,0 +1,7 @@ +libp2p.network.connection.raw_connection +======================================== + +.. automodule:: libp2p.network.connection.raw_connection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/connection/raw_connection_interface.rst b/docs/source/libp2p/network/connection/raw_connection_interface.rst new file mode 100644 index 00000000..9fa91baa --- /dev/null +++ b/docs/source/libp2p/network/connection/raw_connection_interface.rst @@ -0,0 +1,7 @@ +libp2p.network.connection.raw_connection_interface +================================================== + +.. automodule:: libp2p.network.connection.raw_connection_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/connection/swarm_connection.rst b/docs/source/libp2p/network/connection/swarm_connection.rst new file mode 100644 index 00000000..46a2c818 --- /dev/null +++ b/docs/source/libp2p/network/connection/swarm_connection.rst @@ -0,0 +1,7 @@ +libp2p.network.connection.swarm_connection +========================================== + +.. automodule:: libp2p.network.connection.swarm_connection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/exceptions.rst b/docs/source/libp2p/network/exceptions.rst new file mode 100644 index 00000000..5a491b32 --- /dev/null +++ b/docs/source/libp2p/network/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.network.exceptions +========================= + +.. automodule:: libp2p.network.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/index.rst b/docs/source/libp2p/network/index.rst new file mode 100644 index 00000000..0b9b8847 --- /dev/null +++ b/docs/source/libp2p/network/index.rst @@ -0,0 +1,16 @@ +libp2p.network +============== + +.. toctree:: + exceptions.rst + network_interface.rst + notifee_interface.rst + swarm.rst + connection/exceptions.rst + connection/net_connection_interface.rst + connection/raw_connection_interface.rst + connection/raw_connection.rst + connection/swarm_connection.rst + stream/exceptions.rst + stream/net_stream_interface.rst + stream/net_stream.rst diff --git a/docs/source/libp2p/network/network_interface.rst b/docs/source/libp2p/network/network_interface.rst new file mode 100644 index 00000000..74cb9fc8 --- /dev/null +++ b/docs/source/libp2p/network/network_interface.rst @@ -0,0 +1,7 @@ +libp2p.network.network_interface +================================ + +.. automodule:: libp2p.network.network_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/notifee_interface.rst b/docs/source/libp2p/network/notifee_interface.rst new file mode 100644 index 00000000..1ddfc2c6 --- /dev/null +++ b/docs/source/libp2p/network/notifee_interface.rst @@ -0,0 +1,7 @@ +libp2p.network.notifee_interface +================================ + +.. automodule:: libp2p.network.notifee_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/stream/exceptions.rst b/docs/source/libp2p/network/stream/exceptions.rst new file mode 100644 index 00000000..4419f305 --- /dev/null +++ b/docs/source/libp2p/network/stream/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.network.stream.exceptions +================================ + +.. automodule:: libp2p.network.stream.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/stream/net_stream.rst b/docs/source/libp2p/network/stream/net_stream.rst new file mode 100644 index 00000000..f4bed52a --- /dev/null +++ b/docs/source/libp2p/network/stream/net_stream.rst @@ -0,0 +1,7 @@ +libp2p.network.stream.net_stream +========================================== + +.. automodule:: libp2p.network.stream.net_stream + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/stream/net_stream_interface.rst b/docs/source/libp2p/network/stream/net_stream_interface.rst new file mode 100644 index 00000000..c2a50a5b --- /dev/null +++ b/docs/source/libp2p/network/stream/net_stream_interface.rst @@ -0,0 +1,7 @@ +libp2p.network.stream.net_stream_interface +========================================== + +.. automodule:: libp2p.network.stream.net_stream_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/network/swarm.rst b/docs/source/libp2p/network/swarm.rst new file mode 100644 index 00000000..c8ae11e3 --- /dev/null +++ b/docs/source/libp2p/network/swarm.rst @@ -0,0 +1,7 @@ +libp2p.network.swarm +==================== + +.. automodule:: libp2p.network.swarm + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/peer/addrbook_interface.rst b/docs/source/libp2p/peer/addrbook_interface.rst new file mode 100644 index 00000000..d3d2ca0b --- /dev/null +++ b/docs/source/libp2p/peer/addrbook_interface.rst @@ -0,0 +1,7 @@ +libp2p.peer.addrbook_interface +============================== + +.. automodule:: libp2p.peer.addrbook_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/peer/id.rst b/docs/source/libp2p/peer/id.rst new file mode 100644 index 00000000..1b14e4d8 --- /dev/null +++ b/docs/source/libp2p/peer/id.rst @@ -0,0 +1,7 @@ +libp2p.peer.id +============== + +.. automodule:: libp2p.peer.id + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/peer/index.rst b/docs/source/libp2p/peer/index.rst new file mode 100644 index 00000000..080b867e --- /dev/null +++ b/docs/source/libp2p/peer/index.rst @@ -0,0 +1,12 @@ +libp2p.peer +=========== + +.. toctree:: + addrbook_interface.rst + id.rst + peerdata_interface.rst + peerdata.rst + peerinfo.rst + peermetadata_interface.rst + peerstore_interface.rst + peerstore.rst diff --git a/docs/source/libp2p/peer/peerdata.rst b/docs/source/libp2p/peer/peerdata.rst new file mode 100644 index 00000000..5b7cd3af --- /dev/null +++ b/docs/source/libp2p/peer/peerdata.rst @@ -0,0 +1,7 @@ +libp2p.peer.peerdata +==================== + +.. automodule:: libp2p.peer.peerdata + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/peer/peerdata_interface.rst b/docs/source/libp2p/peer/peerdata_interface.rst new file mode 100644 index 00000000..bb07f51d --- /dev/null +++ b/docs/source/libp2p/peer/peerdata_interface.rst @@ -0,0 +1,7 @@ +libp2p.peer.peerdata_interface +============================== + +.. automodule:: libp2p.peer.peerdata_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/peer/peerinfo.rst b/docs/source/libp2p/peer/peerinfo.rst new file mode 100644 index 00000000..989bcdb6 --- /dev/null +++ b/docs/source/libp2p/peer/peerinfo.rst @@ -0,0 +1,7 @@ +libp2p.peer.peerinfo +==================== + +.. automodule:: libp2p.peer.peerinfo + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/peer/peermetadata_interface.rst b/docs/source/libp2p/peer/peermetadata_interface.rst new file mode 100644 index 00000000..194dd0a8 --- /dev/null +++ b/docs/source/libp2p/peer/peermetadata_interface.rst @@ -0,0 +1,7 @@ +libp2p.peer.peermetadata_interface +================================== + +.. automodule:: libp2p.peer.peermetadata_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/peer/peerstore.rst b/docs/source/libp2p/peer/peerstore.rst new file mode 100644 index 00000000..465aaf28 --- /dev/null +++ b/docs/source/libp2p/peer/peerstore.rst @@ -0,0 +1,7 @@ +libp2p.peer.peerstore +===================== + +.. automodule:: libp2p.peer.peerstore + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/peer/peerstore_interface.rst b/docs/source/libp2p/peer/peerstore_interface.rst new file mode 100644 index 00000000..24cf9752 --- /dev/null +++ b/docs/source/libp2p/peer/peerstore_interface.rst @@ -0,0 +1,7 @@ +libp2p.peer.peerstore_interface +=============================== + +.. automodule:: libp2p.peer.peerstore_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/protocol_muxer/exceptions.rst b/docs/source/libp2p/protocol_muxer/exceptions.rst new file mode 100644 index 00000000..977c223d --- /dev/null +++ b/docs/source/libp2p/protocol_muxer/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.protocol_muxer.exceptions +================================ + +.. automodule:: libp2p.protocol_muxer.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/protocol_muxer/index.rst b/docs/source/libp2p/protocol_muxer/index.rst new file mode 100644 index 00000000..74172142 --- /dev/null +++ b/docs/source/libp2p/protocol_muxer/index.rst @@ -0,0 +1,11 @@ +libp2p.protocol\_muxer +====================== + +.. toctree:: + exceptions.rst + multiselect_client_interface.rst + multiselect_client.rst + multiselect_communicator_interface.rst + multiselect_communicator.rst + multiselect_muxer_interface.rst + multiselect.rst diff --git a/docs/source/libp2p/protocol_muxer/multiselect.rst b/docs/source/libp2p/protocol_muxer/multiselect.rst new file mode 100644 index 00000000..6a429e9a --- /dev/null +++ b/docs/source/libp2p/protocol_muxer/multiselect.rst @@ -0,0 +1,7 @@ +libp2p.protocol_muxer.multiselect +================================= + +.. automodule:: libp2p.protocol_muxer.multiselect + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/protocol_muxer/multiselect_client.rst b/docs/source/libp2p/protocol_muxer/multiselect_client.rst new file mode 100644 index 00000000..5f0ccd54 --- /dev/null +++ b/docs/source/libp2p/protocol_muxer/multiselect_client.rst @@ -0,0 +1,7 @@ +libp2p.protocol_muxer.multiselect_client +======================================== + +.. automodule:: libp2p.protocol_muxer.multiselect_client + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/protocol_muxer/multiselect_client_interface.rst b/docs/source/libp2p/protocol_muxer/multiselect_client_interface.rst new file mode 100644 index 00000000..7bb7d229 --- /dev/null +++ b/docs/source/libp2p/protocol_muxer/multiselect_client_interface.rst @@ -0,0 +1,7 @@ +libp2p.protocol_muxer.multiselect_client_interface +================================================== + +.. automodule:: libp2p.protocol_muxer.multiselect_client_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/protocol_muxer/multiselect_communicator.rst b/docs/source/libp2p/protocol_muxer/multiselect_communicator.rst new file mode 100644 index 00000000..2af2c2ba --- /dev/null +++ b/docs/source/libp2p/protocol_muxer/multiselect_communicator.rst @@ -0,0 +1,7 @@ +libp2p.protocol_muxer.multiselect_communicator +============================================== + +.. automodule:: libp2p.protocol_muxer.multiselect_communicator + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/protocol_muxer/multiselect_communicator_interface.rst b/docs/source/libp2p/protocol_muxer/multiselect_communicator_interface.rst new file mode 100644 index 00000000..91e1b3a7 --- /dev/null +++ b/docs/source/libp2p/protocol_muxer/multiselect_communicator_interface.rst @@ -0,0 +1,7 @@ +libp2p.protocol_muxer.multiselect_communicator_interface +======================================================== + +.. automodule:: libp2p.protocol_muxer.multiselect_communicator_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/protocol_muxer/multiselect_muxer_interface.rst b/docs/source/libp2p/protocol_muxer/multiselect_muxer_interface.rst new file mode 100644 index 00000000..db0228ca --- /dev/null +++ b/docs/source/libp2p/protocol_muxer/multiselect_muxer_interface.rst @@ -0,0 +1,7 @@ +libp2p.protocol_muxer.multiselect_muxer_interface +================================================= + +.. automodule:: libp2p.protocol_muxer.multiselect_muxer_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/pubsub/floodsub.rst b/docs/source/libp2p/pubsub/floodsub.rst new file mode 100644 index 00000000..06b13e07 --- /dev/null +++ b/docs/source/libp2p/pubsub/floodsub.rst @@ -0,0 +1,7 @@ +libp2p.pubsub.floodsub +====================== + +.. automodule:: libp2p.pubsub.floodsub + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/pubsub/gossipsub.rst b/docs/source/libp2p/pubsub/gossipsub.rst new file mode 100644 index 00000000..beeb694a --- /dev/null +++ b/docs/source/libp2p/pubsub/gossipsub.rst @@ -0,0 +1,7 @@ +libp2p.pubsub.gossipsub +======================= + +.. automodule:: libp2p.pubsub.gossipsub + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/pubsub/index.rst b/docs/source/libp2p/pubsub/index.rst new file mode 100644 index 00000000..abac7e59 --- /dev/null +++ b/docs/source/libp2p/pubsub/index.rst @@ -0,0 +1,11 @@ +libp2p.pubsub +============= + +.. toctree:: + floodsub.rst + gossipsub.rst + mcache.rst + pubsub_notifee.rst + pubsub_router_interface.rst + pubsub.rst + validators.rst diff --git a/docs/source/libp2p/pubsub/mcache.rst b/docs/source/libp2p/pubsub/mcache.rst new file mode 100644 index 00000000..61f1ac20 --- /dev/null +++ b/docs/source/libp2p/pubsub/mcache.rst @@ -0,0 +1,7 @@ +libp2p.pubsub.mcache +==================== + +.. automodule:: libp2p.pubsub.mcache + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/pubsub/pubsub.rst b/docs/source/libp2p/pubsub/pubsub.rst new file mode 100644 index 00000000..3f1f6efd --- /dev/null +++ b/docs/source/libp2p/pubsub/pubsub.rst @@ -0,0 +1,7 @@ +libp2p.pubsub.pubsub +==================== + +.. automodule:: libp2p.pubsub.pubsub + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/pubsub/pubsub_notifee.rst b/docs/source/libp2p/pubsub/pubsub_notifee.rst new file mode 100644 index 00000000..c2db4b46 --- /dev/null +++ b/docs/source/libp2p/pubsub/pubsub_notifee.rst @@ -0,0 +1,7 @@ +libp2p.pubsub.pubsub_notifee +============================ + +.. automodule:: libp2p.pubsub.pubsub_notifee + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/pubsub/pubsub_router_interface.rst b/docs/source/libp2p/pubsub/pubsub_router_interface.rst new file mode 100644 index 00000000..8f54bfa6 --- /dev/null +++ b/docs/source/libp2p/pubsub/pubsub_router_interface.rst @@ -0,0 +1,7 @@ +libp2p.pubsub.pubsub_router_interface +===================================== + +.. automodule:: libp2p.pubsub.pubsub_router_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/pubsub/validators.rst b/docs/source/libp2p/pubsub/validators.rst new file mode 100644 index 00000000..47caf5e4 --- /dev/null +++ b/docs/source/libp2p/pubsub/validators.rst @@ -0,0 +1,7 @@ +libp2p.pubsub.validators +======================== + +.. automodule:: libp2p.pubsub.validators + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/routing/index.rst b/docs/source/libp2p/routing/index.rst new file mode 100644 index 00000000..f0952ba2 --- /dev/null +++ b/docs/source/libp2p/routing/index.rst @@ -0,0 +1,7 @@ +libp2p.routing +============== + +.. toctree:: + interfaces.rst + kademlia/kademlia_content_router.rst + kademlia/kademlia_peer_router.rst diff --git a/docs/source/libp2p/routing/interfaces.rst b/docs/source/libp2p/routing/interfaces.rst new file mode 100644 index 00000000..cc808d26 --- /dev/null +++ b/docs/source/libp2p/routing/interfaces.rst @@ -0,0 +1,7 @@ +libp2p.routing.interfaces +========================= + +.. automodule:: libp2p.routing.interfaces + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/routing/kademlia/kademlia_content_router.rst b/docs/source/libp2p/routing/kademlia/kademlia_content_router.rst new file mode 100644 index 00000000..17d8c265 --- /dev/null +++ b/docs/source/libp2p/routing/kademlia/kademlia_content_router.rst @@ -0,0 +1,7 @@ +libp2p.routing.kademlia.kademlia_content_router +=============================================== + +.. automodule:: libp2p.routing.kademlia.kademlia_content_router + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/routing/kademlia/kademlia_peer_router.rst b/docs/source/libp2p/routing/kademlia/kademlia_peer_router.rst new file mode 100644 index 00000000..63bb4dc5 --- /dev/null +++ b/docs/source/libp2p/routing/kademlia/kademlia_peer_router.rst @@ -0,0 +1,7 @@ +libp2p.routing.kademlia.kademlia_peer_router +============================================ + +.. automodule:: libp2p.routing.kademlia.kademlia_peer_router + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/security/base_session.rst b/docs/source/libp2p/security/base_session.rst new file mode 100644 index 00000000..9159dcad --- /dev/null +++ b/docs/source/libp2p/security/base_session.rst @@ -0,0 +1,7 @@ +libp2p.security.base_session +============================ + +.. automodule:: libp2p.security.base_session + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/security/base_transport.rst b/docs/source/libp2p/security/base_transport.rst new file mode 100644 index 00000000..55e8f698 --- /dev/null +++ b/docs/source/libp2p/security/base_transport.rst @@ -0,0 +1,7 @@ +libp2p.security.base_transport +============================== + +.. automodule:: libp2p.security.base_transport + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/security/exceptions.rst b/docs/source/libp2p/security/exceptions.rst new file mode 100644 index 00000000..504553d8 --- /dev/null +++ b/docs/source/libp2p/security/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.security.exceptions +========================== + +.. automodule:: libp2p.security.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/security/index.rst b/docs/source/libp2p/security/index.rst new file mode 100644 index 00000000..75420f55 --- /dev/null +++ b/docs/source/libp2p/security/index.rst @@ -0,0 +1,15 @@ +libp2p.security +=============== + +.. toctree:: + insecure/transport.rst + insecure/pb/plaintext_pb2.rst + secio/exceptions.rst + secio/transport.rst + secio/pb/spipe_pb2.rst + base_session.rst + base_transport.rst + exceptions.rst + secure_conn_interface.rst + secure_transport_interface.rst + security_multistream.rst diff --git a/docs/source/libp2p/security/insecure/pb/plaintext_pb2.rst b/docs/source/libp2p/security/insecure/pb/plaintext_pb2.rst new file mode 100644 index 00000000..4f3f90c9 --- /dev/null +++ b/docs/source/libp2p/security/insecure/pb/plaintext_pb2.rst @@ -0,0 +1,7 @@ +libp2p.security.insecure.pb.plaintext_pb2 +========================================= + +.. automodule:: libp2p.security.insecure.pb.plaintext_pb2 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/security/insecure/transport.rst b/docs/source/libp2p/security/insecure/transport.rst new file mode 100644 index 00000000..eb6ddce5 --- /dev/null +++ b/docs/source/libp2p/security/insecure/transport.rst @@ -0,0 +1,7 @@ +libp2p.security.insecure.transport +================================== + +.. automodule:: libp2p.security.insecure.transport + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/security/secio/exceptions.rst b/docs/source/libp2p/security/secio/exceptions.rst new file mode 100644 index 00000000..c8dde64f --- /dev/null +++ b/docs/source/libp2p/security/secio/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.security.secio.exceptions +================================ + +.. automodule:: libp2p.security.secio.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/security/secio/pb/spipe_pb2.rst b/docs/source/libp2p/security/secio/pb/spipe_pb2.rst new file mode 100644 index 00000000..f9a96da1 --- /dev/null +++ b/docs/source/libp2p/security/secio/pb/spipe_pb2.rst @@ -0,0 +1,7 @@ +libp2p.security.secio.pb.spipe_pb2 +================================== + +.. automodule:: libp2p.security.secio.pb.spipe_pb2 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/security/secio/transport.rst b/docs/source/libp2p/security/secio/transport.rst new file mode 100644 index 00000000..99446b5e --- /dev/null +++ b/docs/source/libp2p/security/secio/transport.rst @@ -0,0 +1,7 @@ +libp2p.security.secio.transport +=============================== + +.. automodule:: libp2p.security.secio.transport + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/security/secure_conn_interface.rst b/docs/source/libp2p/security/secure_conn_interface.rst new file mode 100644 index 00000000..46d20675 --- /dev/null +++ b/docs/source/libp2p/security/secure_conn_interface.rst @@ -0,0 +1,7 @@ +libp2p.security.secure_conn_interface +===================================== + +.. automodule:: libp2p.security.secure_conn_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/security/secure_transport_interface.rst b/docs/source/libp2p/security/secure_transport_interface.rst new file mode 100644 index 00000000..5949d810 --- /dev/null +++ b/docs/source/libp2p/security/secure_transport_interface.rst @@ -0,0 +1,7 @@ +libp2p.security.secure_transport_interface +========================================== + +.. automodule:: libp2p.security.secure_transport_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/security/security_multistream.rst b/docs/source/libp2p/security/security_multistream.rst new file mode 100644 index 00000000..639deddb --- /dev/null +++ b/docs/source/libp2p/security/security_multistream.rst @@ -0,0 +1,7 @@ +libp2p.security.security_multistream +==================================== + +.. automodule:: libp2p.security.security_multistream + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/stream_muxer/abc.rst b/docs/source/libp2p/stream_muxer/abc.rst new file mode 100644 index 00000000..6114bf5f --- /dev/null +++ b/docs/source/libp2p/stream_muxer/abc.rst @@ -0,0 +1,7 @@ +libp2p.stream_muxer.abc +======================= + +.. automodule:: libp2p.stream_muxer.abc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/stream_muxer/exceptions.rst b/docs/source/libp2p/stream_muxer/exceptions.rst new file mode 100644 index 00000000..e87f3c01 --- /dev/null +++ b/docs/source/libp2p/stream_muxer/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.stream_muxer.exceptions +============================== + +.. automodule:: libp2p.stream_muxer.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/stream_muxer/index.rst b/docs/source/libp2p/stream_muxer/index.rst new file mode 100644 index 00000000..81e61ee1 --- /dev/null +++ b/docs/source/libp2p/stream_muxer/index.rst @@ -0,0 +1,12 @@ +libp2p.stream\_muxer +==================== + +.. toctree:: + mplex/constants.rst + mplex/datastructures.rst + mplex/exceptions.rst + mplex/mplex_stream.rst + mplex/mplex.rst + abc.rst + exceptions.rst + muxer_multistream.rst diff --git a/docs/source/libp2p/stream_muxer/mplex/constants.rst b/docs/source/libp2p/stream_muxer/mplex/constants.rst new file mode 100644 index 00000000..71f2f350 --- /dev/null +++ b/docs/source/libp2p/stream_muxer/mplex/constants.rst @@ -0,0 +1,7 @@ +libp2p.stream_muxer.mplex.constants +=================================== + +.. automodule:: libp2p.stream_muxer.mplex.constants + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/stream_muxer/mplex/datastructures.rst b/docs/source/libp2p/stream_muxer/mplex/datastructures.rst new file mode 100644 index 00000000..6eb66737 --- /dev/null +++ b/docs/source/libp2p/stream_muxer/mplex/datastructures.rst @@ -0,0 +1,7 @@ +libp2p.stream_muxer.mplex.datastructures +======================================== + +.. automodule:: libp2p.stream_muxer.mplex.datastructures + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/stream_muxer/mplex/exceptions.rst b/docs/source/libp2p/stream_muxer/mplex/exceptions.rst new file mode 100644 index 00000000..ba8d2297 --- /dev/null +++ b/docs/source/libp2p/stream_muxer/mplex/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.stream_muxer.mplex.exceptions +==================================== + +.. automodule:: libp2p.stream_muxer.mplex.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/stream_muxer/mplex/mplex.rst b/docs/source/libp2p/stream_muxer/mplex/mplex.rst new file mode 100644 index 00000000..a69eeaae --- /dev/null +++ b/docs/source/libp2p/stream_muxer/mplex/mplex.rst @@ -0,0 +1,7 @@ +libp2p.stream_muxer.mplex.mplex +=============================== + +.. automodule:: libp2p.stream_muxer.mplex.mplex + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/stream_muxer/mplex/mplex_stream.rst b/docs/source/libp2p/stream_muxer/mplex/mplex_stream.rst new file mode 100644 index 00000000..a7ab0754 --- /dev/null +++ b/docs/source/libp2p/stream_muxer/mplex/mplex_stream.rst @@ -0,0 +1,7 @@ +libp2p.stream_muxer.mplex.mplex_stream +====================================== + +.. automodule:: libp2p.stream_muxer.mplex.mplex_stream + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/stream_muxer/muxer_multistream.rst b/docs/source/libp2p/stream_muxer/muxer_multistream.rst new file mode 100644 index 00000000..61f762c4 --- /dev/null +++ b/docs/source/libp2p/stream_muxer/muxer_multistream.rst @@ -0,0 +1,7 @@ +libp2p.stream_muxer.muxer_multistream +===================================== + +.. automodule:: libp2p.stream_muxer.muxer_multistream + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/transport/exceptions.rst b/docs/source/libp2p/transport/exceptions.rst new file mode 100644 index 00000000..f909712d --- /dev/null +++ b/docs/source/libp2p/transport/exceptions.rst @@ -0,0 +1,7 @@ +libp2p.transport.exceptions +=========================== + +.. automodule:: libp2p.transport.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/transport/index.rst b/docs/source/libp2p/transport/index.rst new file mode 100644 index 00000000..a06e62c7 --- /dev/null +++ b/docs/source/libp2p/transport/index.rst @@ -0,0 +1,10 @@ +libp2p.transport +================ + +.. toctree:: + tcp/tcp.rst + exceptions.rst + listener_interface.rst + transport_interface.rst + typing.rst + upgrader.rst diff --git a/docs/source/libp2p/transport/listener_interface.rst b/docs/source/libp2p/transport/listener_interface.rst new file mode 100644 index 00000000..0c0cff4c --- /dev/null +++ b/docs/source/libp2p/transport/listener_interface.rst @@ -0,0 +1,7 @@ +libp2p.transport.listener_interface +=================================== + +.. automodule:: libp2p.transport.listener_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/transport/tcp/tcp.rst b/docs/source/libp2p/transport/tcp/tcp.rst new file mode 100644 index 00000000..ca258201 --- /dev/null +++ b/docs/source/libp2p/transport/tcp/tcp.rst @@ -0,0 +1,7 @@ +libp2p.transport.tcp.tcp +=========================== + +.. automodule:: libp2p.transport.tcp.tcp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/transport/transport_interface.rst b/docs/source/libp2p/transport/transport_interface.rst new file mode 100644 index 00000000..3e62293b --- /dev/null +++ b/docs/source/libp2p/transport/transport_interface.rst @@ -0,0 +1,7 @@ +libp2p.transport.transport_interface +==================================== + +.. automodule:: libp2p.transport.transport_interface + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/transport/typing.rst b/docs/source/libp2p/transport/typing.rst new file mode 100644 index 00000000..ca2eaea8 --- /dev/null +++ b/docs/source/libp2p/transport/typing.rst @@ -0,0 +1,7 @@ +libp2p.transport.typing +======================= + +.. automodule:: libp2p.transport.typing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/transport/upgrader.rst b/docs/source/libp2p/transport/upgrader.rst new file mode 100644 index 00000000..b9585f90 --- /dev/null +++ b/docs/source/libp2p/transport/upgrader.rst @@ -0,0 +1,7 @@ +libp2p.transport.upgrader +========================= + +.. automodule:: libp2p.transport.upgrader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/libp2p/typing.rst b/docs/source/libp2p/typing.rst new file mode 100644 index 00000000..c4afeb11 --- /dev/null +++ b/docs/source/libp2p/typing.rst @@ -0,0 +1,7 @@ +libp2p.typing +============= + +.. automodule:: libp2p.typing + :members: + :undoc-members: + :show-inheritance: diff --git a/libp2p/network/swarm.py b/libp2p/network/swarm.py index 90c9475a..8f07436d 100644 --- a/libp2p/network/swarm.py +++ b/libp2p/network/swarm.py @@ -153,14 +153,17 @@ async def listen(self, *multiaddrs: Multiaddr) -> bool: :param multiaddrs: one or many multiaddrs to start listening on :return: true if at least one success - For each multiaddr - Check if a listener for multiaddr exists already - If listener already exists, continue - Otherwise: - Capture multiaddr in conn handler - Have conn handler delegate to stream handler - Call listener listen with the multiaddr - Map multiaddr to listener + :: + + For each multiaddr + Check if a listener for multiaddr exists already + If listener already exists, continue + Otherwise: + Capture multiaddr in conn handler + Have conn handler delegate to stream handler + Call listener listen with the multiaddr + Map multiaddr to listener + """ for maddr in multiaddrs: if str(maddr) in self.listeners: diff --git a/setup.py b/setup.py index 83da86d1..ca5fbcf8 100644 --- a/setup.py +++ b/setup.py @@ -17,10 +17,14 @@ "flake8>=3.7.7,<4.0.0", ], "dev": ["tox>=3.13.2,<4.0.0"], + "doc": ["Sphinx>=2.2.0,<3.0.0", "sphinx-rtd-theme"], } extras_require["dev"] = ( - extras_require["test"] + extras_require["lint"] + extras_require["dev"] + extras_require["test"] + + extras_require["lint"] + + extras_require["dev"] + + extras_require["doc"] )