Skip to content

Commit 283e41e

Browse files
committed
consolidate utils docs sections
1 parent 4f7aa12 commit 283e41e

File tree

3 files changed

+17
-8
lines changed

3 files changed

+17
-8
lines changed

docs/libp2p.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,6 @@ libp2p.custom_types module
5757
:show-inheritance:
5858
:exclude-members: INetStream, IMuxedConn, ISecureTransport
5959

60-
libp2p.utils module
61-
-------------------
62-
63-
.. automodule:: libp2p.utils
64-
:members:
65-
:undoc-members:
66-
:show-inheritance:
67-
6860
Module contents
6961
---------------
7062

docs/libp2p.utils.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,19 @@ libp2p.utils.paths module
4343
:members:
4444
:undoc-members:
4545
:show-inheritance:
46+
47+
libp2p.utils.address_validation module
48+
---------------------------------------
49+
50+
.. automodule:: libp2p.utils.address_validation
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
libp2p.utils.dns_utils module
56+
------------------------------
57+
58+
.. automodule:: libp2p.utils.dns_utils
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:

newsfragments/1296.docs.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Consolidated the ``libp2p.utils`` package documentation into a single page, removing the duplicate module entry and adding missing ``address_validation`` and ``dns_utils`` submodule docs.

0 commit comments

Comments
 (0)