Skip to content

consolidate utils docs sections #1296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pacrob wants to merge 3 commits into
base: main
Choose a base branch
from
Open

consolidate utils docs sections #1296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
283e41e
consolidate utils docs sections
pacrob Mar 31, 2026
b54f0dc
test
pacrob Mar 31, 2026
567a941
test
pacrob Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions docs/libp2p.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,6 @@ libp2p.custom_types module
:show-inheritance:
:exclude-members: INetStream, IMuxedConn, ISecureTransport

libp2p.utils module
-------------------

.. automodule:: libp2p.utils
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

Expand Down
16 changes: 16 additions & 0 deletions docs/libp2p.utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,19 @@ libp2p.utils.paths module
:members:
:undoc-members:
:show-inheritance:

libp2p.utils.address_validation module
---------------------------------------

.. automodule:: libp2p.utils.address_validation
:members:
:undoc-members:
:show-inheritance:

libp2p.utils.dns_utils module
------------------------------

.. automodule:: libp2p.utils.dns_utils
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions newsfragments/1296.docs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +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.
Loading