Skip to content

Commit e018af0

Browse files
committed
feat: add documentation for libp2p.discovery.events and libp2p.discovery.mdns packages
1 parent 7135e6c commit e018af0

File tree

3 files changed

+67
-0
lines changed

3 files changed

+67
-0
lines changed

docs/libp2p.discovery.events.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
libp2p.discovery.events package
2+
===============================
3+
4+
Submodules
5+
----------
6+
7+
libp2p.discovery.events.peerDiscovery module
8+
--------------------------------------------
9+
10+
.. automodule:: libp2p.discovery.events.peerDiscovery
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: libp2p.discovery.events
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

docs/libp2p.discovery.mdns.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
libp2p.discovery.mdns package
2+
=============================
3+
4+
Submodules
5+
----------
6+
7+
libp2p.discovery.mdns.broadcaster module
8+
----------------------------------------
9+
10+
.. automodule:: libp2p.discovery.mdns.broadcaster
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
libp2p.discovery.mdns.listener module
16+
-------------------------------------
17+
18+
.. automodule:: libp2p.discovery.mdns.listener
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
libp2p.discovery.mdns.mdns module
24+
---------------------------------
25+
26+
.. automodule:: libp2p.discovery.mdns.mdns
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
libp2p.discovery.mdns.utils module
32+
----------------------------------
33+
34+
.. automodule:: libp2p.discovery.mdns.utils
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: libp2p.discovery.mdns
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

docs/libp2p.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Subpackages
88
:maxdepth: 4
99

1010
libp2p.crypto
11+
libp2p.discovery
1112
libp2p.host
1213
libp2p.identity
1314
libp2p.io

0 commit comments

Comments
 (0)