From 9af46b679abb976160832c7e80dfd7702318ae7a Mon Sep 17 00:00:00 2001 From: pacrob <5199899+pacrob@users.noreply.github.com> Date: Sat, 23 Mar 2024 17:41:07 -0600 Subject: [PATCH] Create frame for friendlier docs, rebuild autodocs --- docs/code_of_conduct.rst | 12 +++++ docs/contributing.rst | 4 ++ docs/examples.chat.rst | 13 +++-- docs/index.rst | 23 ++++++--- docs/introduction.rst | 11 +++++ docs/libp2p.crypto.pb.rst | 13 +++-- docs/libp2p.crypto.rst | 64 ++++++++++++------------- docs/libp2p.host.rst | 43 ++++++++--------- docs/libp2p.identity.identify.pb.rst | 13 +++-- docs/libp2p.identity.identify.rst | 16 +++---- docs/libp2p.identity.rst | 9 ++-- docs/libp2p.io.rst | 39 ++++++++------- docs/libp2p.network.connection.rst | 37 +++++++------- docs/libp2p.network.rst | 36 +++++++------- docs/libp2p.network.stream.rst | 25 +++++----- docs/libp2p.peer.rst | 55 +++++++++++---------- docs/libp2p.protocol_muxer.rst | 49 ++++++++++--------- docs/libp2p.pubsub.pb.rst | 13 +++-- docs/libp2p.pubsub.rst | 72 +++++++++++++++------------- docs/libp2p.routing.rst | 14 +++--- docs/libp2p.rst | 52 ++++++++++---------- docs/libp2p.security.insecure.pb.rst | 13 +++-- docs/libp2p.security.insecure.rst | 16 +++---- docs/libp2p.security.noise.pb.rst | 1 - docs/libp2p.security.noise.rst | 2 +- docs/libp2p.security.rst | 10 +++- docs/libp2p.security.secio.pb.rst | 13 +++-- docs/libp2p.security.secio.rst | 22 ++++----- docs/libp2p.stream_muxer.mplex.rst | 37 +++++++------- docs/libp2p.stream_muxer.rst | 28 +++++------ docs/libp2p.tools.pubsub.rst | 25 +++++----- docs/libp2p.tools.rst | 30 ++++++------ docs/libp2p.transport.rst | 40 ++++++++-------- docs/libp2p.transport.tcp.rst | 13 +++-- docs/quickstart.rst | 4 ++ 35 files changed, 456 insertions(+), 411 deletions(-) create mode 100644 docs/code_of_conduct.rst create mode 100644 docs/contributing.rst create mode 100644 docs/introduction.rst create mode 100644 docs/quickstart.rst diff --git a/docs/code_of_conduct.rst b/docs/code_of_conduct.rst new file mode 100644 index 00000000..ab830a0c --- /dev/null +++ b/docs/code_of_conduct.rst @@ -0,0 +1,12 @@ +Code of Conduct +=============== + +The libp2p project operates under the `IPFS Code of Conduct `_ + +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. diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 00000000..9145d5fd --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1,4 @@ +Contributing +============ + +TODO - instructions for contributing diff --git a/docs/examples.chat.rst b/docs/examples.chat.rst index 9242803b..5c149bef 100644 --- a/docs/examples.chat.rst +++ b/docs/examples.chat.rst @@ -8,15 +8,14 @@ examples.chat.chat module ------------------------- .. automodule:: examples.chat.chat - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: examples.chat - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index 3757abbe..f2f552e7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,15 +7,24 @@ Contents -------- .. toctree:: - :maxdepth: 3 + :maxdepth: 1 + :caption: General - libp2p + introduction + quickstart release_notes + + +.. toctree:: + :maxdepth: 1 + :caption: py-libp2p + examples + API +.. toctree:: + :maxdepth: 1 + :caption: Community -Indices and tables ------------------- - -* :ref:`genindex` -* :ref:`modindex` + contributing + code_of_conduct diff --git a/docs/introduction.rst b/docs/introduction.rst new file mode 100644 index 00000000..eb0a2042 --- /dev/null +++ b/docs/introduction.rst @@ -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 `_ diff --git a/docs/libp2p.crypto.pb.rst b/docs/libp2p.crypto.pb.rst index 2641266b..4c5b097b 100644 --- a/docs/libp2p.crypto.pb.rst +++ b/docs/libp2p.crypto.pb.rst @@ -8,15 +8,14 @@ libp2p.crypto.pb.crypto\_pb2 module ----------------------------------- .. automodule:: libp2p.crypto.pb.crypto_pb2 - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.crypto.pb - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.crypto.rst b/docs/libp2p.crypto.rst index 8acc707a..3a675a91 100644 --- a/docs/libp2p.crypto.rst +++ b/docs/libp2p.crypto.rst @@ -5,8 +5,9 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 - libp2p.crypto.pb + libp2p.crypto.pb Submodules ---------- @@ -15,79 +16,78 @@ libp2p.crypto.authenticated\_encryption module ---------------------------------------------- .. automodule:: libp2p.crypto.authenticated_encryption - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.crypto.ecc module ------------------------ .. automodule:: libp2p.crypto.ecc - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.crypto.ed25519 module ---------------------------- .. automodule:: libp2p.crypto.ed25519 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.crypto.exceptions module ------------------------------- .. automodule:: libp2p.crypto.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.crypto.key\_exchange module ---------------------------------- .. automodule:: libp2p.crypto.key_exchange - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.crypto.keys module ------------------------- .. automodule:: libp2p.crypto.keys - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.crypto.rsa module ------------------------ .. automodule:: libp2p.crypto.rsa - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.crypto.secp256k1 module ------------------------------ .. automodule:: libp2p.crypto.secp256k1 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.crypto.serialization module ---------------------------------- .. automodule:: libp2p.crypto.serialization - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.crypto - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.host.rst b/docs/libp2p.host.rst index f2e4b075..95debb94 100644 --- a/docs/libp2p.host.rst +++ b/docs/libp2p.host.rst @@ -8,55 +8,54 @@ libp2p.host.basic\_host module ------------------------------ .. automodule:: libp2p.host.basic_host - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.host.defaults module --------------------------- .. automodule:: libp2p.host.defaults - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.host.exceptions module ----------------------------- .. automodule:: libp2p.host.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.host.host\_interface module ---------------------------------- .. automodule:: libp2p.host.host_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.host.ping module ----------------------- .. automodule:: libp2p.host.ping - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.host.routed\_host module ------------------------------- .. automodule:: libp2p.host.routed_host - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.host - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.identity.identify.pb.rst b/docs/libp2p.identity.identify.pb.rst index a707a4a5..844db951 100644 --- a/docs/libp2p.identity.identify.pb.rst +++ b/docs/libp2p.identity.identify.pb.rst @@ -8,15 +8,14 @@ libp2p.identity.identify.pb.identify\_pb2 module ------------------------------------------------ .. automodule:: libp2p.identity.identify.pb.identify_pb2 - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.identity.identify.pb - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.identity.identify.rst b/docs/libp2p.identity.identify.rst index cd9f94d0..e6d892d0 100644 --- a/docs/libp2p.identity.identify.rst +++ b/docs/libp2p.identity.identify.rst @@ -5,8 +5,9 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 - libp2p.identity.identify.pb + libp2p.identity.identify.pb Submodules ---------- @@ -15,15 +16,14 @@ libp2p.identity.identify.protocol module ---------------------------------------- .. automodule:: libp2p.identity.identify.protocol - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.identity.identify - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.identity.rst b/docs/libp2p.identity.rst index 4535ce6a..ccd89182 100644 --- a/docs/libp2p.identity.rst +++ b/docs/libp2p.identity.rst @@ -5,13 +5,14 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 - libp2p.identity.identify + libp2p.identity.identify Module contents --------------- .. automodule:: libp2p.identity - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.io.rst b/docs/libp2p.io.rst index 87c17bde..ce25b743 100644 --- a/docs/libp2p.io.rst +++ b/docs/libp2p.io.rst @@ -8,39 +8,46 @@ libp2p.io.abc module -------------------- .. automodule:: libp2p.io.abc - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.io.exceptions module --------------------------- .. automodule:: libp2p.io.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.io.msgio module ---------------------- .. automodule:: libp2p.io.msgio - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: + +libp2p.io.trio module +--------------------- + +.. automodule:: libp2p.io.trio + :members: + :undoc-members: + :show-inheritance: libp2p.io.utils module ---------------------- .. automodule:: libp2p.io.utils - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.io - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.network.connection.rst b/docs/libp2p.network.connection.rst index f50dde21..17d87695 100644 --- a/docs/libp2p.network.connection.rst +++ b/docs/libp2p.network.connection.rst @@ -8,47 +8,46 @@ libp2p.network.connection.exceptions module ------------------------------------------- .. automodule:: libp2p.network.connection.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.network.connection.net\_connection\_interface module ----------------------------------------------------------- .. automodule:: libp2p.network.connection.net_connection_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.network.connection.raw\_connection module ------------------------------------------------ .. automodule:: libp2p.network.connection.raw_connection - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.network.connection.raw\_connection\_interface module ----------------------------------------------------------- .. automodule:: libp2p.network.connection.raw_connection_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.network.connection.swarm\_connection module -------------------------------------------------- .. automodule:: libp2p.network.connection.swarm_connection - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.network.connection - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.network.rst b/docs/libp2p.network.rst index 2ef65e9c..0b2644c6 100644 --- a/docs/libp2p.network.rst +++ b/docs/libp2p.network.rst @@ -5,9 +5,10 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 - libp2p.network.connection - libp2p.network.stream + libp2p.network.connection + libp2p.network.stream Submodules ---------- @@ -16,39 +17,38 @@ libp2p.network.exceptions module -------------------------------- .. automodule:: libp2p.network.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.network.network\_interface module ---------------------------------------- .. automodule:: libp2p.network.network_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.network.notifee\_interface module ---------------------------------------- .. automodule:: libp2p.network.notifee_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.network.swarm module --------------------------- .. automodule:: libp2p.network.swarm - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.network - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.network.stream.rst b/docs/libp2p.network.stream.rst index 73538216..9acddf35 100644 --- a/docs/libp2p.network.stream.rst +++ b/docs/libp2p.network.stream.rst @@ -8,31 +8,30 @@ libp2p.network.stream.exceptions module --------------------------------------- .. automodule:: libp2p.network.stream.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.network.stream.net\_stream module ---------------------------------------- .. automodule:: libp2p.network.stream.net_stream - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.network.stream.net\_stream\_interface module --------------------------------------------------- .. automodule:: libp2p.network.stream.net_stream_interface - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.network.stream - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.peer.rst b/docs/libp2p.peer.rst index 668daa53..34dc59a6 100644 --- a/docs/libp2p.peer.rst +++ b/docs/libp2p.peer.rst @@ -8,71 +8,70 @@ libp2p.peer.addrbook\_interface module -------------------------------------- .. automodule:: libp2p.peer.addrbook_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.peer.id module --------------------- .. automodule:: libp2p.peer.id - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.peer.peerdata module --------------------------- .. automodule:: libp2p.peer.peerdata - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.peer.peerdata\_interface module -------------------------------------- .. automodule:: libp2p.peer.peerdata_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.peer.peerinfo module --------------------------- .. automodule:: libp2p.peer.peerinfo - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.peer.peermetadata\_interface module ------------------------------------------ .. automodule:: libp2p.peer.peermetadata_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.peer.peerstore module ---------------------------- .. automodule:: libp2p.peer.peerstore - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.peer.peerstore\_interface module --------------------------------------- .. automodule:: libp2p.peer.peerstore_interface - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.peer - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.protocol_muxer.rst b/docs/libp2p.protocol_muxer.rst index 69044d61..3c7f3270 100644 --- a/docs/libp2p.protocol_muxer.rst +++ b/docs/libp2p.protocol_muxer.rst @@ -8,63 +8,62 @@ libp2p.protocol\_muxer.exceptions module ---------------------------------------- .. automodule:: libp2p.protocol_muxer.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.protocol\_muxer.multiselect module ----------------------------------------- .. automodule:: libp2p.protocol_muxer.multiselect - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.protocol\_muxer.multiselect\_client module ------------------------------------------------- .. automodule:: libp2p.protocol_muxer.multiselect_client - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.protocol\_muxer.multiselect\_client\_interface module ------------------------------------------------------------ .. automodule:: libp2p.protocol_muxer.multiselect_client_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.protocol\_muxer.multiselect\_communicator module ------------------------------------------------------- .. automodule:: libp2p.protocol_muxer.multiselect_communicator - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.protocol\_muxer.multiselect\_communicator\_interface module ------------------------------------------------------------------ .. automodule:: libp2p.protocol_muxer.multiselect_communicator_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.protocol\_muxer.multiselect\_muxer\_interface module ----------------------------------------------------------- .. automodule:: libp2p.protocol_muxer.multiselect_muxer_interface - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.protocol_muxer - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.pubsub.pb.rst b/docs/libp2p.pubsub.pb.rst index 2a8a8e9a..b475b9db 100644 --- a/docs/libp2p.pubsub.pb.rst +++ b/docs/libp2p.pubsub.pb.rst @@ -8,15 +8,14 @@ libp2p.pubsub.pb.rpc\_pb2 module -------------------------------- .. automodule:: libp2p.pubsub.pb.rpc_pb2 - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.pubsub.pb - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.pubsub.rst b/docs/libp2p.pubsub.rst index 38dce6ff..e3a9bdff 100644 --- a/docs/libp2p.pubsub.rst +++ b/docs/libp2p.pubsub.rst @@ -5,8 +5,9 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 - libp2p.pubsub.pb + libp2p.pubsub.pb Submodules ---------- @@ -15,79 +16,86 @@ libp2p.pubsub.abc module ------------------------ .. automodule:: libp2p.pubsub.abc - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.pubsub.exceptions module ------------------------------- .. automodule:: libp2p.pubsub.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.pubsub.floodsub module ----------------------------- .. automodule:: libp2p.pubsub.floodsub - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.pubsub.gossipsub module ------------------------------ .. automodule:: libp2p.pubsub.gossipsub - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.pubsub.mcache module --------------------------- .. automodule:: libp2p.pubsub.mcache - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.pubsub.pubsub module --------------------------- .. automodule:: libp2p.pubsub.pubsub - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.pubsub.pubsub\_notifee module ------------------------------------ .. automodule:: libp2p.pubsub.pubsub_notifee - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.pubsub.subscription module --------------------------------- .. automodule:: libp2p.pubsub.subscription - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: + +libp2p.pubsub.typing module +--------------------------- + +.. automodule:: libp2p.pubsub.typing + :members: + :undoc-members: + :show-inheritance: libp2p.pubsub.validators module ------------------------------- .. automodule:: libp2p.pubsub.validators - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.pubsub - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.routing.rst b/docs/libp2p.routing.rst index 88b3c5b2..a456e457 100644 --- a/docs/libp2p.routing.rst +++ b/docs/libp2p.routing.rst @@ -1,7 +1,6 @@ libp2p.routing package ====================== - Submodules ---------- @@ -9,15 +8,14 @@ libp2p.routing.interfaces module -------------------------------- .. automodule:: libp2p.routing.interfaces - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.routing - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.rst b/docs/libp2p.rst index a50db7ed..8aa68d46 100644 --- a/docs/libp2p.rst +++ b/docs/libp2p.rst @@ -5,20 +5,21 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 - libp2p.crypto - libp2p.host - libp2p.identity - libp2p.io - libp2p.network - libp2p.peer - libp2p.protocol_muxer - libp2p.pubsub - libp2p.routing - libp2p.security - libp2p.stream_muxer - libp2p.tools - libp2p.transport + libp2p.crypto + libp2p.host + libp2p.identity + libp2p.io + libp2p.network + libp2p.peer + libp2p.protocol_muxer + libp2p.pubsub + libp2p.routing + libp2p.security + libp2p.stream_muxer + libp2p.tools + libp2p.transport Submodules ---------- @@ -27,31 +28,30 @@ libp2p.exceptions module ------------------------ .. automodule:: libp2p.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.typing module -------------------- .. automodule:: libp2p.typing - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.utils module ------------------- .. automodule:: libp2p.utils - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.security.insecure.pb.rst b/docs/libp2p.security.insecure.pb.rst index dc24e858..5775f971 100644 --- a/docs/libp2p.security.insecure.pb.rst +++ b/docs/libp2p.security.insecure.pb.rst @@ -8,15 +8,14 @@ libp2p.security.insecure.pb.plaintext\_pb2 module ------------------------------------------------- .. automodule:: libp2p.security.insecure.pb.plaintext_pb2 - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.security.insecure.pb - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.security.insecure.rst b/docs/libp2p.security.insecure.rst index 0f25b5b3..73790b98 100644 --- a/docs/libp2p.security.insecure.rst +++ b/docs/libp2p.security.insecure.rst @@ -5,8 +5,9 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 - libp2p.security.insecure.pb + libp2p.security.insecure.pb Submodules ---------- @@ -15,15 +16,14 @@ libp2p.security.insecure.transport module ----------------------------------------- .. automodule:: libp2p.security.insecure.transport - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.security.insecure - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.security.noise.pb.rst b/docs/libp2p.security.noise.pb.rst index 10881367..d4d8f584 100644 --- a/docs/libp2p.security.noise.pb.rst +++ b/docs/libp2p.security.noise.pb.rst @@ -12,7 +12,6 @@ libp2p.security.noise.pb.noise\_pb2 module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/libp2p.security.noise.rst b/docs/libp2p.security.noise.rst index 65ae79ad..6a9276f8 100644 --- a/docs/libp2p.security.noise.rst +++ b/docs/libp2p.security.noise.rst @@ -5,6 +5,7 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 libp2p.security.noise.pb @@ -51,7 +52,6 @@ libp2p.security.noise.transport module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/libp2p.security.rst b/docs/libp2p.security.rst index 32dd329b..c559a319 100644 --- a/docs/libp2p.security.rst +++ b/docs/libp2p.security.rst @@ -5,6 +5,7 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 libp2p.security.insecure libp2p.security.noise @@ -45,6 +46,14 @@ libp2p.security.secure\_conn\_interface module :undoc-members: :show-inheritance: +libp2p.security.secure\_session module +-------------------------------------- + +.. automodule:: libp2p.security.secure_session + :members: + :undoc-members: + :show-inheritance: + libp2p.security.secure\_transport\_interface module --------------------------------------------------- @@ -61,7 +70,6 @@ libp2p.security.security\_multistream module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/libp2p.security.secio.pb.rst b/docs/libp2p.security.secio.pb.rst index c0cf61b9..75e0b34f 100644 --- a/docs/libp2p.security.secio.pb.rst +++ b/docs/libp2p.security.secio.pb.rst @@ -8,15 +8,14 @@ libp2p.security.secio.pb.spipe\_pb2 module ------------------------------------------ .. automodule:: libp2p.security.secio.pb.spipe_pb2 - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.security.secio.pb - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.security.secio.rst b/docs/libp2p.security.secio.rst index da20b8b1..97f74ae3 100644 --- a/docs/libp2p.security.secio.rst +++ b/docs/libp2p.security.secio.rst @@ -5,8 +5,9 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 - libp2p.security.secio.pb + libp2p.security.secio.pb Submodules ---------- @@ -15,23 +16,22 @@ libp2p.security.secio.exceptions module --------------------------------------- .. automodule:: libp2p.security.secio.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.security.secio.transport module -------------------------------------- .. automodule:: libp2p.security.secio.transport - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.security.secio - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.stream_muxer.mplex.rst b/docs/libp2p.stream_muxer.mplex.rst index 37e92e53..4bb3077e 100644 --- a/docs/libp2p.stream_muxer.mplex.rst +++ b/docs/libp2p.stream_muxer.mplex.rst @@ -8,47 +8,46 @@ libp2p.stream\_muxer.mplex.constants module ------------------------------------------- .. automodule:: libp2p.stream_muxer.mplex.constants - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.stream\_muxer.mplex.datastructures module ------------------------------------------------ .. automodule:: libp2p.stream_muxer.mplex.datastructures - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.stream\_muxer.mplex.exceptions module -------------------------------------------- .. automodule:: libp2p.stream_muxer.mplex.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.stream\_muxer.mplex.mplex module --------------------------------------- .. automodule:: libp2p.stream_muxer.mplex.mplex - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.stream\_muxer.mplex.mplex\_stream module ----------------------------------------------- .. automodule:: libp2p.stream_muxer.mplex.mplex_stream - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.stream_muxer.mplex - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.stream_muxer.rst b/docs/libp2p.stream_muxer.rst index 12114ece..de1a9156 100644 --- a/docs/libp2p.stream_muxer.rst +++ b/docs/libp2p.stream_muxer.rst @@ -5,8 +5,9 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 - libp2p.stream_muxer.mplex + libp2p.stream_muxer.mplex Submodules ---------- @@ -15,31 +16,30 @@ libp2p.stream\_muxer.abc module ------------------------------- .. automodule:: libp2p.stream_muxer.abc - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.stream\_muxer.exceptions module -------------------------------------- .. automodule:: libp2p.stream_muxer.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.stream\_muxer.muxer\_multistream module ---------------------------------------------- .. automodule:: libp2p.stream_muxer.muxer_multistream - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.stream_muxer - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.tools.pubsub.rst b/docs/libp2p.tools.pubsub.rst index 91b130c5..aef47a6b 100644 --- a/docs/libp2p.tools.pubsub.rst +++ b/docs/libp2p.tools.pubsub.rst @@ -8,31 +8,30 @@ libp2p.tools.pubsub.dummy\_account\_node module ----------------------------------------------- .. automodule:: libp2p.tools.pubsub.dummy_account_node - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.tools.pubsub.floodsub\_integration\_test\_settings module ---------------------------------------------------------------- .. automodule:: libp2p.tools.pubsub.floodsub_integration_test_settings - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.tools.pubsub.utils module -------------------------------- .. automodule:: libp2p.tools.pubsub.utils - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.tools.pubsub - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.tools.rst b/docs/libp2p.tools.rst index 2d7846fc..7230a537 100644 --- a/docs/libp2p.tools.rst +++ b/docs/libp2p.tools.rst @@ -5,10 +5,9 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 - libp2p.tools.pubsub - -The interop module is left out for now, because of the extra dependencies it requires. + libp2p.tools.pubsub Submodules ---------- @@ -17,31 +16,30 @@ libp2p.tools.constants module ----------------------------- .. automodule:: libp2p.tools.constants - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.tools.factories module ----------------------------- .. automodule:: libp2p.tools.factories - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.tools.utils module ------------------------- .. automodule:: libp2p.tools.utils - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.tools - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.transport.rst b/docs/libp2p.transport.rst index 2fe53335..6541f52d 100644 --- a/docs/libp2p.transport.rst +++ b/docs/libp2p.transport.rst @@ -5,8 +5,9 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 - libp2p.transport.tcp + libp2p.transport.tcp Submodules ---------- @@ -15,47 +16,46 @@ libp2p.transport.exceptions module ---------------------------------- .. automodule:: libp2p.transport.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.transport.listener\_interface module ------------------------------------------- .. automodule:: libp2p.transport.listener_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.transport.transport\_interface module -------------------------------------------- .. automodule:: libp2p.transport.transport_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.transport.typing module ------------------------------ .. automodule:: libp2p.transport.typing - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.transport.upgrader module -------------------------------- .. automodule:: libp2p.transport.upgrader - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.transport - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/libp2p.transport.tcp.rst b/docs/libp2p.transport.tcp.rst index 374e1e5a..5ad53d52 100644 --- a/docs/libp2p.transport.tcp.rst +++ b/docs/libp2p.transport.tcp.rst @@ -8,15 +8,14 @@ libp2p.transport.tcp.tcp module ------------------------------- .. automodule:: libp2p.transport.tcp.tcp - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.transport.tcp - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/quickstart.rst b/docs/quickstart.rst new file mode 100644 index 00000000..27216ca4 --- /dev/null +++ b/docs/quickstart.rst @@ -0,0 +1,4 @@ +Quickstart +================ + +TODO - add quickstart instructions