varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2026-02-09 14:40:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Create frame for friendlier docs, rebuild autodocs

Browse Source
This commit is contained in:
pacrob
2024-03-23 17:41:07 -06:00
committed by Paul Robinson
parent 5eb98a2288
commit 9af46b679a
35 changed files with 456 additions and 411 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/code_of_conduct.rst Normal file
View File

@ -0,0 +1,12 @@
Code of Conduct
===============
The libp2p project operates under the `IPFS Code of Conduct <https://github.com/ipfs/community/blob/master/code-of-conduct.md>`_
tl;dr:
- Be respectful.
- We're here to help: abuse@ipfs.io
- Abusive behavior is never tolerated.
- Violations of this code may result in swift and permanent expulsion from the IPFS [and libp2p] community.
- "Too long, didn't read" is not a valid excuse for not knowing what is in this document.

4
docs/contributing.rst Normal file
View File

@ -0,0 +1,4 @@
Contributing
============
TODO - instructions for contributing

13
docs/examples.chat.rst
View File

@ -8,15 +8,14 @@ examples.chat.chat module
------------------------- -------------------------
.. automodule:: examples.chat.chat .. automodule:: examples.chat.chat
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: examples.chat .. automodule:: examples.chat
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

23
docs/index.rst
View File

@ -7,15 +7,24 @@ Contents
-------- --------
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 1
:caption: General
libp2p introduction
quickstart
release_notes release_notes
.. toctree::
:maxdepth: 1
:caption: py-libp2p
examples examples
API <libp2p>
.. toctree::
:maxdepth: 1
:caption: Community
Indices and tables contributing
------------------ code_of_conduct
* :ref:`genindex`
* :ref:`modindex`

11
docs/introduction.rst Normal file
View File

@ -0,0 +1,11 @@
Introduction
============
py-libp2p is the Python implementation of the libp2p networking stack.
It hopes to someday be fully compatible with other implementations of libp2p.
This project is still in its early stages, and is not yet ready for production use.
Further Reading
---------------
`libp2p main site <https://libp2p.io/>`_

13
docs/libp2p.crypto.pb.rst
View File

@ -8,15 +8,14 @@ libp2p.crypto.pb.crypto\_pb2 module
----------------------------------- -----------------------------------
.. automodule:: libp2p.crypto.pb.crypto_pb2 .. automodule:: libp2p.crypto.pb.crypto_pb2
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.crypto.pb .. automodule:: libp2p.crypto.pb
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

64
docs/libp2p.crypto.rst
View File

@ -5,8 +5,9 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.crypto.pb libp2p.crypto.pb
Submodules Submodules
---------- ----------
@ -15,79 +16,78 @@ libp2p.crypto.authenticated\_encryption module
---------------------------------------------- ----------------------------------------------
.. automodule:: libp2p.crypto.authenticated_encryption .. automodule:: libp2p.crypto.authenticated_encryption
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.crypto.ecc module libp2p.crypto.ecc module
------------------------ ------------------------
.. automodule:: libp2p.crypto.ecc .. automodule:: libp2p.crypto.ecc
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.crypto.ed25519 module libp2p.crypto.ed25519 module
---------------------------- ----------------------------
.. automodule:: libp2p.crypto.ed25519 .. automodule:: libp2p.crypto.ed25519
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.crypto.exceptions module libp2p.crypto.exceptions module
------------------------------- -------------------------------
.. automodule:: libp2p.crypto.exceptions .. automodule:: libp2p.crypto.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.crypto.key\_exchange module libp2p.crypto.key\_exchange module
---------------------------------- ----------------------------------
.. automodule:: libp2p.crypto.key_exchange .. automodule:: libp2p.crypto.key_exchange
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.crypto.keys module libp2p.crypto.keys module
------------------------- -------------------------
.. automodule:: libp2p.crypto.keys .. automodule:: libp2p.crypto.keys
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.crypto.rsa module libp2p.crypto.rsa module
------------------------ ------------------------
.. automodule:: libp2p.crypto.rsa .. automodule:: libp2p.crypto.rsa
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.crypto.secp256k1 module libp2p.crypto.secp256k1 module
------------------------------ ------------------------------
.. automodule:: libp2p.crypto.secp256k1 .. automodule:: libp2p.crypto.secp256k1
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.crypto.serialization module libp2p.crypto.serialization module
---------------------------------- ----------------------------------
.. automodule:: libp2p.crypto.serialization .. automodule:: libp2p.crypto.serialization
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.crypto .. automodule:: libp2p.crypto
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

43
docs/libp2p.host.rst
View File

@ -8,55 +8,54 @@ libp2p.host.basic\_host module
------------------------------ ------------------------------
.. automodule:: libp2p.host.basic_host .. automodule:: libp2p.host.basic_host
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.host.defaults module libp2p.host.defaults module
--------------------------- ---------------------------
.. automodule:: libp2p.host.defaults .. automodule:: libp2p.host.defaults
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.host.exceptions module libp2p.host.exceptions module
----------------------------- -----------------------------
.. automodule:: libp2p.host.exceptions .. automodule:: libp2p.host.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.host.host\_interface module libp2p.host.host\_interface module
---------------------------------- ----------------------------------
.. automodule:: libp2p.host.host_interface .. automodule:: libp2p.host.host_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.host.ping module libp2p.host.ping module
----------------------- -----------------------
.. automodule:: libp2p.host.ping .. automodule:: libp2p.host.ping
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.host.routed\_host module libp2p.host.routed\_host module
------------------------------- -------------------------------
.. automodule:: libp2p.host.routed_host .. automodule:: libp2p.host.routed_host
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.host .. automodule:: libp2p.host
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

13
docs/libp2p.identity.identify.pb.rst
View File

@ -8,15 +8,14 @@ libp2p.identity.identify.pb.identify\_pb2 module
------------------------------------------------ ------------------------------------------------
.. automodule:: libp2p.identity.identify.pb.identify_pb2 .. automodule:: libp2p.identity.identify.pb.identify_pb2
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.identity.identify.pb .. automodule:: libp2p.identity.identify.pb
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

16
docs/libp2p.identity.identify.rst
View File

@ -5,8 +5,9 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.identity.identify.pb libp2p.identity.identify.pb
Submodules Submodules
---------- ----------
@ -15,15 +16,14 @@ libp2p.identity.identify.protocol module
---------------------------------------- ----------------------------------------
.. automodule:: libp2p.identity.identify.protocol .. automodule:: libp2p.identity.identify.protocol
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.identity.identify .. automodule:: libp2p.identity.identify
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

9
docs/libp2p.identity.rst
View File

@ -5,13 +5,14 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.identity.identify libp2p.identity.identify
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.identity .. automodule:: libp2p.identity
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

39
docs/libp2p.io.rst
View File

@ -8,39 +8,46 @@ libp2p.io.abc module
-------------------- --------------------
.. automodule:: libp2p.io.abc .. automodule:: libp2p.io.abc
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.io.exceptions module libp2p.io.exceptions module
--------------------------- ---------------------------
.. automodule:: libp2p.io.exceptions .. automodule:: libp2p.io.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.io.msgio module libp2p.io.msgio module
---------------------- ----------------------
.. automodule:: libp2p.io.msgio .. automodule:: libp2p.io.msgio
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.io.trio module
---------------------
.. automodule:: libp2p.io.trio
:members:
:undoc-members:
:show-inheritance:
libp2p.io.utils module libp2p.io.utils module
---------------------- ----------------------
.. automodule:: libp2p.io.utils .. automodule:: libp2p.io.utils
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.io .. automodule:: libp2p.io
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

37
docs/libp2p.network.connection.rst
View File

@ -8,47 +8,46 @@ libp2p.network.connection.exceptions module
------------------------------------------- -------------------------------------------
.. automodule:: libp2p.network.connection.exceptions .. automodule:: libp2p.network.connection.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.network.connection.net\_connection\_interface module libp2p.network.connection.net\_connection\_interface module
----------------------------------------------------------- -----------------------------------------------------------
.. automodule:: libp2p.network.connection.net_connection_interface .. automodule:: libp2p.network.connection.net_connection_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.network.connection.raw\_connection module libp2p.network.connection.raw\_connection module
------------------------------------------------ ------------------------------------------------
.. automodule:: libp2p.network.connection.raw_connection .. automodule:: libp2p.network.connection.raw_connection
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.network.connection.raw\_connection\_interface module libp2p.network.connection.raw\_connection\_interface module
----------------------------------------------------------- -----------------------------------------------------------
.. automodule:: libp2p.network.connection.raw_connection_interface .. automodule:: libp2p.network.connection.raw_connection_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.network.connection.swarm\_connection module libp2p.network.connection.swarm\_connection module
-------------------------------------------------- --------------------------------------------------
.. automodule:: libp2p.network.connection.swarm_connection .. automodule:: libp2p.network.connection.swarm_connection
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.network.connection .. automodule:: libp2p.network.connection
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

36
docs/libp2p.network.rst
View File

@ -5,9 +5,10 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.network.connection libp2p.network.connection
libp2p.network.stream libp2p.network.stream
Submodules Submodules
---------- ----------
@ -16,39 +17,38 @@ libp2p.network.exceptions module
-------------------------------- --------------------------------
.. automodule:: libp2p.network.exceptions .. automodule:: libp2p.network.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.network.network\_interface module libp2p.network.network\_interface module
---------------------------------------- ----------------------------------------
.. automodule:: libp2p.network.network_interface .. automodule:: libp2p.network.network_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.network.notifee\_interface module libp2p.network.notifee\_interface module
---------------------------------------- ----------------------------------------
.. automodule:: libp2p.network.notifee_interface .. automodule:: libp2p.network.notifee_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.network.swarm module libp2p.network.swarm module
--------------------------- ---------------------------
.. automodule:: libp2p.network.swarm .. automodule:: libp2p.network.swarm
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.network .. automodule:: libp2p.network
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

25
docs/libp2p.network.stream.rst
View File

@ -8,31 +8,30 @@ libp2p.network.stream.exceptions module
--------------------------------------- ---------------------------------------
.. automodule:: libp2p.network.stream.exceptions .. automodule:: libp2p.network.stream.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.network.stream.net\_stream module libp2p.network.stream.net\_stream module
---------------------------------------- ----------------------------------------
.. automodule:: libp2p.network.stream.net_stream .. automodule:: libp2p.network.stream.net_stream
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.network.stream.net\_stream\_interface module libp2p.network.stream.net\_stream\_interface module
--------------------------------------------------- ---------------------------------------------------
.. automodule:: libp2p.network.stream.net_stream_interface .. automodule:: libp2p.network.stream.net_stream_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.network.stream .. automodule:: libp2p.network.stream
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

55
docs/libp2p.peer.rst
View File

@ -8,71 +8,70 @@ libp2p.peer.addrbook\_interface module
-------------------------------------- --------------------------------------
.. automodule:: libp2p.peer.addrbook_interface .. automodule:: libp2p.peer.addrbook_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.peer.id module libp2p.peer.id module
--------------------- ---------------------
.. automodule:: libp2p.peer.id .. automodule:: libp2p.peer.id
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.peer.peerdata module libp2p.peer.peerdata module
--------------------------- ---------------------------
.. automodule:: libp2p.peer.peerdata .. automodule:: libp2p.peer.peerdata
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.peer.peerdata\_interface module libp2p.peer.peerdata\_interface module
-------------------------------------- --------------------------------------
.. automodule:: libp2p.peer.peerdata_interface .. automodule:: libp2p.peer.peerdata_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.peer.peerinfo module libp2p.peer.peerinfo module
--------------------------- ---------------------------
.. automodule:: libp2p.peer.peerinfo .. automodule:: libp2p.peer.peerinfo
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.peer.peermetadata\_interface module libp2p.peer.peermetadata\_interface module
------------------------------------------ ------------------------------------------
.. automodule:: libp2p.peer.peermetadata_interface .. automodule:: libp2p.peer.peermetadata_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.peer.peerstore module libp2p.peer.peerstore module
---------------------------- ----------------------------
.. automodule:: libp2p.peer.peerstore .. automodule:: libp2p.peer.peerstore
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.peer.peerstore\_interface module libp2p.peer.peerstore\_interface module
--------------------------------------- ---------------------------------------
.. automodule:: libp2p.peer.peerstore_interface .. automodule:: libp2p.peer.peerstore_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.peer .. automodule:: libp2p.peer
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

49
docs/libp2p.protocol_muxer.rst
View File

@ -8,63 +8,62 @@ libp2p.protocol\_muxer.exceptions module
---------------------------------------- ----------------------------------------
.. automodule:: libp2p.protocol_muxer.exceptions .. automodule:: libp2p.protocol_muxer.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.protocol\_muxer.multiselect module libp2p.protocol\_muxer.multiselect module
----------------------------------------- -----------------------------------------
.. automodule:: libp2p.protocol_muxer.multiselect .. automodule:: libp2p.protocol_muxer.multiselect
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.protocol\_muxer.multiselect\_client module libp2p.protocol\_muxer.multiselect\_client module
------------------------------------------------- -------------------------------------------------
.. automodule:: libp2p.protocol_muxer.multiselect_client .. automodule:: libp2p.protocol_muxer.multiselect_client
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.protocol\_muxer.multiselect\_client\_interface module libp2p.protocol\_muxer.multiselect\_client\_interface module
------------------------------------------------------------ ------------------------------------------------------------
.. automodule:: libp2p.protocol_muxer.multiselect_client_interface .. automodule:: libp2p.protocol_muxer.multiselect_client_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.protocol\_muxer.multiselect\_communicator module libp2p.protocol\_muxer.multiselect\_communicator module
------------------------------------------------------- -------------------------------------------------------
.. automodule:: libp2p.protocol_muxer.multiselect_communicator .. automodule:: libp2p.protocol_muxer.multiselect_communicator
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.protocol\_muxer.multiselect\_communicator\_interface module libp2p.protocol\_muxer.multiselect\_communicator\_interface module
------------------------------------------------------------------ ------------------------------------------------------------------
.. automodule:: libp2p.protocol_muxer.multiselect_communicator_interface .. automodule:: libp2p.protocol_muxer.multiselect_communicator_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.protocol\_muxer.multiselect\_muxer\_interface module libp2p.protocol\_muxer.multiselect\_muxer\_interface module
----------------------------------------------------------- -----------------------------------------------------------
.. automodule:: libp2p.protocol_muxer.multiselect_muxer_interface .. automodule:: libp2p.protocol_muxer.multiselect_muxer_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.protocol_muxer .. automodule:: libp2p.protocol_muxer
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

13
docs/libp2p.pubsub.pb.rst
View File

@ -8,15 +8,14 @@ libp2p.pubsub.pb.rpc\_pb2 module
-------------------------------- --------------------------------
.. automodule:: libp2p.pubsub.pb.rpc_pb2 .. automodule:: libp2p.pubsub.pb.rpc_pb2
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.pubsub.pb .. automodule:: libp2p.pubsub.pb
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

72
docs/libp2p.pubsub.rst
View File

@ -5,8 +5,9 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.pubsub.pb libp2p.pubsub.pb
Submodules Submodules
---------- ----------
@ -15,79 +16,86 @@ libp2p.pubsub.abc module
------------------------ ------------------------
.. automodule:: libp2p.pubsub.abc .. automodule:: libp2p.pubsub.abc
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.pubsub.exceptions module libp2p.pubsub.exceptions module
------------------------------- -------------------------------
.. automodule:: libp2p.pubsub.exceptions .. automodule:: libp2p.pubsub.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.pubsub.floodsub module libp2p.pubsub.floodsub module
----------------------------- -----------------------------
.. automodule:: libp2p.pubsub.floodsub .. automodule:: libp2p.pubsub.floodsub
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.pubsub.gossipsub module libp2p.pubsub.gossipsub module
------------------------------ ------------------------------
.. automodule:: libp2p.pubsub.gossipsub .. automodule:: libp2p.pubsub.gossipsub
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.pubsub.mcache module libp2p.pubsub.mcache module
--------------------------- ---------------------------
.. automodule:: libp2p.pubsub.mcache .. automodule:: libp2p.pubsub.mcache
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.pubsub.pubsub module libp2p.pubsub.pubsub module
--------------------------- ---------------------------
.. automodule:: libp2p.pubsub.pubsub .. automodule:: libp2p.pubsub.pubsub
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.pubsub.pubsub\_notifee module libp2p.pubsub.pubsub\_notifee module
------------------------------------ ------------------------------------
.. automodule:: libp2p.pubsub.pubsub_notifee .. automodule:: libp2p.pubsub.pubsub_notifee
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.pubsub.subscription module libp2p.pubsub.subscription module
--------------------------------- ---------------------------------
.. automodule:: libp2p.pubsub.subscription .. automodule:: libp2p.pubsub.subscription
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.pubsub.typing module
---------------------------
.. automodule:: libp2p.pubsub.typing
:members:
:undoc-members:
:show-inheritance:
libp2p.pubsub.validators module libp2p.pubsub.validators module
------------------------------- -------------------------------
.. automodule:: libp2p.pubsub.validators .. automodule:: libp2p.pubsub.validators
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.pubsub .. automodule:: libp2p.pubsub
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

14
docs/libp2p.routing.rst
View File

@ -1,7 +1,6 @@
libp2p.routing package libp2p.routing package
====================== ======================
Submodules Submodules
---------- ----------
@ -9,15 +8,14 @@ libp2p.routing.interfaces module
-------------------------------- --------------------------------
.. automodule:: libp2p.routing.interfaces .. automodule:: libp2p.routing.interfaces
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.routing .. automodule:: libp2p.routing
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

52
docs/libp2p.rst
View File

@ -5,20 +5,21 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.crypto libp2p.crypto
libp2p.host libp2p.host
libp2p.identity libp2p.identity
libp2p.io libp2p.io
libp2p.network libp2p.network
libp2p.peer libp2p.peer
libp2p.protocol_muxer libp2p.protocol_muxer
libp2p.pubsub libp2p.pubsub
libp2p.routing libp2p.routing
libp2p.security libp2p.security
libp2p.stream_muxer libp2p.stream_muxer
libp2p.tools libp2p.tools
libp2p.transport libp2p.transport
Submodules Submodules
---------- ----------
@ -27,31 +28,30 @@ libp2p.exceptions module
------------------------ ------------------------
.. automodule:: libp2p.exceptions .. automodule:: libp2p.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.typing module libp2p.typing module
-------------------- --------------------
.. automodule:: libp2p.typing .. automodule:: libp2p.typing
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.utils module libp2p.utils module
------------------- -------------------
.. automodule:: libp2p.utils .. automodule:: libp2p.utils
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p .. automodule:: libp2p
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

13
docs/libp2p.security.insecure.pb.rst
View File

@ -8,15 +8,14 @@ libp2p.security.insecure.pb.plaintext\_pb2 module
------------------------------------------------- -------------------------------------------------
.. automodule:: libp2p.security.insecure.pb.plaintext_pb2 .. automodule:: libp2p.security.insecure.pb.plaintext_pb2
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.security.insecure.pb .. automodule:: libp2p.security.insecure.pb
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

16
docs/libp2p.security.insecure.rst
View File

@ -5,8 +5,9 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.security.insecure.pb libp2p.security.insecure.pb
Submodules Submodules
---------- ----------
@ -15,15 +16,14 @@ libp2p.security.insecure.transport module
----------------------------------------- -----------------------------------------
.. automodule:: libp2p.security.insecure.transport .. automodule:: libp2p.security.insecure.transport
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.security.insecure .. automodule:: libp2p.security.insecure
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

1
docs/libp2p.security.noise.pb.rst
View File

@ -12,7 +12,6 @@ libp2p.security.noise.pb.noise\_pb2 module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------

2
docs/libp2p.security.noise.rst
View File

@ -5,6 +5,7 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.security.noise.pb libp2p.security.noise.pb
@ -51,7 +52,6 @@ libp2p.security.noise.transport module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------

10
docs/libp2p.security.rst
View File

@ -5,6 +5,7 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.security.insecure libp2p.security.insecure
libp2p.security.noise libp2p.security.noise
@ -45,6 +46,14 @@ libp2p.security.secure\_conn\_interface module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.security.secure\_session module
--------------------------------------
.. automodule:: libp2p.security.secure_session
:members:
:undoc-members:
:show-inheritance:
libp2p.security.secure\_transport\_interface module libp2p.security.secure\_transport\_interface module
--------------------------------------------------- ---------------------------------------------------
@ -61,7 +70,6 @@ libp2p.security.security\_multistream module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------

13
docs/libp2p.security.secio.pb.rst
View File

@ -8,15 +8,14 @@ libp2p.security.secio.pb.spipe\_pb2 module
------------------------------------------ ------------------------------------------
.. automodule:: libp2p.security.secio.pb.spipe_pb2 .. automodule:: libp2p.security.secio.pb.spipe_pb2
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.security.secio.pb .. automodule:: libp2p.security.secio.pb
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

22
docs/libp2p.security.secio.rst
View File

@ -5,8 +5,9 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.security.secio.pb libp2p.security.secio.pb
Submodules Submodules
---------- ----------
@ -15,23 +16,22 @@ libp2p.security.secio.exceptions module
--------------------------------------- ---------------------------------------
.. automodule:: libp2p.security.secio.exceptions .. automodule:: libp2p.security.secio.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.security.secio.transport module libp2p.security.secio.transport module
-------------------------------------- --------------------------------------
.. automodule:: libp2p.security.secio.transport .. automodule:: libp2p.security.secio.transport
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.security.secio .. automodule:: libp2p.security.secio
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

37
docs/libp2p.stream_muxer.mplex.rst
View File

@ -8,47 +8,46 @@ libp2p.stream\_muxer.mplex.constants module
------------------------------------------- -------------------------------------------
.. automodule:: libp2p.stream_muxer.mplex.constants .. automodule:: libp2p.stream_muxer.mplex.constants
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.stream\_muxer.mplex.datastructures module libp2p.stream\_muxer.mplex.datastructures module
------------------------------------------------ ------------------------------------------------
.. automodule:: libp2p.stream_muxer.mplex.datastructures .. automodule:: libp2p.stream_muxer.mplex.datastructures
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.stream\_muxer.mplex.exceptions module libp2p.stream\_muxer.mplex.exceptions module
-------------------------------------------- --------------------------------------------
.. automodule:: libp2p.stream_muxer.mplex.exceptions .. automodule:: libp2p.stream_muxer.mplex.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.stream\_muxer.mplex.mplex module libp2p.stream\_muxer.mplex.mplex module
--------------------------------------- ---------------------------------------
.. automodule:: libp2p.stream_muxer.mplex.mplex .. automodule:: libp2p.stream_muxer.mplex.mplex
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.stream\_muxer.mplex.mplex\_stream module libp2p.stream\_muxer.mplex.mplex\_stream module
----------------------------------------------- -----------------------------------------------
.. automodule:: libp2p.stream_muxer.mplex.mplex_stream .. automodule:: libp2p.stream_muxer.mplex.mplex_stream
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.stream_muxer.mplex .. automodule:: libp2p.stream_muxer.mplex
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

28
docs/libp2p.stream_muxer.rst
View File

@ -5,8 +5,9 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.stream_muxer.mplex libp2p.stream_muxer.mplex
Submodules Submodules
---------- ----------
@ -15,31 +16,30 @@ libp2p.stream\_muxer.abc module
------------------------------- -------------------------------
.. automodule:: libp2p.stream_muxer.abc .. automodule:: libp2p.stream_muxer.abc
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.stream\_muxer.exceptions module libp2p.stream\_muxer.exceptions module
-------------------------------------- --------------------------------------
.. automodule:: libp2p.stream_muxer.exceptions .. automodule:: libp2p.stream_muxer.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.stream\_muxer.muxer\_multistream module libp2p.stream\_muxer.muxer\_multistream module
---------------------------------------------- ----------------------------------------------
.. automodule:: libp2p.stream_muxer.muxer_multistream .. automodule:: libp2p.stream_muxer.muxer_multistream
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.stream_muxer .. automodule:: libp2p.stream_muxer
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

25
docs/libp2p.tools.pubsub.rst
View File

@ -8,31 +8,30 @@ libp2p.tools.pubsub.dummy\_account\_node module
----------------------------------------------- -----------------------------------------------
.. automodule:: libp2p.tools.pubsub.dummy_account_node .. automodule:: libp2p.tools.pubsub.dummy_account_node
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.tools.pubsub.floodsub\_integration\_test\_settings module libp2p.tools.pubsub.floodsub\_integration\_test\_settings module
---------------------------------------------------------------- ----------------------------------------------------------------
.. automodule:: libp2p.tools.pubsub.floodsub_integration_test_settings .. automodule:: libp2p.tools.pubsub.floodsub_integration_test_settings
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.tools.pubsub.utils module libp2p.tools.pubsub.utils module
-------------------------------- --------------------------------
.. automodule:: libp2p.tools.pubsub.utils .. automodule:: libp2p.tools.pubsub.utils
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.tools.pubsub .. automodule:: libp2p.tools.pubsub
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

30
docs/libp2p.tools.rst
View File

@ -5,10 +5,9 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.tools.pubsub libp2p.tools.pubsub
The interop module is left out for now, because of the extra dependencies it requires.
Submodules Submodules
---------- ----------
@ -17,31 +16,30 @@ libp2p.tools.constants module
----------------------------- -----------------------------
.. automodule:: libp2p.tools.constants .. automodule:: libp2p.tools.constants
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.tools.factories module libp2p.tools.factories module
----------------------------- -----------------------------
.. automodule:: libp2p.tools.factories .. automodule:: libp2p.tools.factories
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.tools.utils module libp2p.tools.utils module
------------------------- -------------------------
.. automodule:: libp2p.tools.utils .. automodule:: libp2p.tools.utils
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.tools .. automodule:: libp2p.tools
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

40
docs/libp2p.transport.rst
View File

@ -5,8 +5,9 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
libp2p.transport.tcp libp2p.transport.tcp
Submodules Submodules
---------- ----------
@ -15,47 +16,46 @@ libp2p.transport.exceptions module
---------------------------------- ----------------------------------
.. automodule:: libp2p.transport.exceptions .. automodule:: libp2p.transport.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.transport.listener\_interface module libp2p.transport.listener\_interface module
------------------------------------------- -------------------------------------------
.. automodule:: libp2p.transport.listener_interface .. automodule:: libp2p.transport.listener_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.transport.transport\_interface module libp2p.transport.transport\_interface module
-------------------------------------------- --------------------------------------------
.. automodule:: libp2p.transport.transport_interface .. automodule:: libp2p.transport.transport_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.transport.typing module libp2p.transport.typing module
------------------------------ ------------------------------
.. automodule:: libp2p.transport.typing .. automodule:: libp2p.transport.typing
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.transport.upgrader module libp2p.transport.upgrader module
-------------------------------- --------------------------------
.. automodule:: libp2p.transport.upgrader .. automodule:: libp2p.transport.upgrader
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.transport .. automodule:: libp2p.transport
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

13
docs/libp2p.transport.tcp.rst
View File

@ -8,15 +8,14 @@ libp2p.transport.tcp.tcp module
------------------------------- -------------------------------
.. automodule:: libp2p.transport.tcp.tcp .. automodule:: libp2p.transport.tcp.tcp
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.transport.tcp .. automodule:: libp2p.transport.tcp
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

4
docs/quickstart.rst Normal file
View File

@ -0,0 +1,4 @@
Quickstart
================
TODO - add quickstart instructions