From e018af09ae428a02f8a77bf9ccbb9e29e8c01f9f Mon Sep 17 00:00:00 2001 From: "sumanjeet0012@gmail.com" Date: Sat, 21 Jun 2025 01:30:16 +0530 Subject: [PATCH] feat: add documentation for libp2p.discovery.events and libp2p.discovery.mdns packages --- docs/libp2p.discovery.events.rst | 21 +++++++++++++++ docs/libp2p.discovery.mdns.rst | 45 ++++++++++++++++++++++++++++++++ docs/libp2p.rst | 1 + 3 files changed, 67 insertions(+) create mode 100644 docs/libp2p.discovery.events.rst create mode 100644 docs/libp2p.discovery.mdns.rst diff --git a/docs/libp2p.discovery.events.rst b/docs/libp2p.discovery.events.rst new file mode 100644 index 00000000..bfac0eb5 --- /dev/null +++ b/docs/libp2p.discovery.events.rst @@ -0,0 +1,21 @@ +libp2p.discovery.events package +=============================== + +Submodules +---------- + +libp2p.discovery.events.peerDiscovery module +-------------------------------------------- + +.. automodule:: libp2p.discovery.events.peerDiscovery + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: libp2p.discovery.events + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/libp2p.discovery.mdns.rst b/docs/libp2p.discovery.mdns.rst new file mode 100644 index 00000000..474c6725 --- /dev/null +++ b/docs/libp2p.discovery.mdns.rst @@ -0,0 +1,45 @@ +libp2p.discovery.mdns package +============================= + +Submodules +---------- + +libp2p.discovery.mdns.broadcaster module +---------------------------------------- + +.. automodule:: libp2p.discovery.mdns.broadcaster + :members: + :undoc-members: + :show-inheritance: + +libp2p.discovery.mdns.listener module +------------------------------------- + +.. automodule:: libp2p.discovery.mdns.listener + :members: + :undoc-members: + :show-inheritance: + +libp2p.discovery.mdns.mdns module +--------------------------------- + +.. automodule:: libp2p.discovery.mdns.mdns + :members: + :undoc-members: + :show-inheritance: + +libp2p.discovery.mdns.utils module +---------------------------------- + +.. automodule:: libp2p.discovery.mdns.utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: libp2p.discovery.mdns + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/libp2p.rst b/docs/libp2p.rst index 749b4c11..a47e011a 100644 --- a/docs/libp2p.rst +++ b/docs/libp2p.rst @@ -8,6 +8,7 @@ Subpackages :maxdepth: 4 libp2p.crypto + libp2p.discovery libp2p.host libp2p.identity libp2p.io