Noise: fix docs

This commit is contained in:
mhchia 2020-02-15 12:35:36 +08:00
parent f4c545ed68
commit 4620544d45
No known key found for this signature in database
GPG Key ID: 389EFBEA1362589A
3 changed files with 91 additions and 23 deletions

View File

@ -0,0 +1,22 @@
libp2p.security.noise.pb package
================================
Submodules
----------
libp2p.security.noise.pb.noise\_pb2 module
------------------------------------------
.. automodule:: libp2p.security.noise.pb.noise_pb2
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: libp2p.security.noise.pb
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,45 @@
libp2p.security.noise package
=============================
Subpackages
-----------
.. toctree::
libp2p.security.noise.pb
Submodules
----------
libp2p.security.noise.connection module
---------------------------------------
.. automodule:: libp2p.security.noise.connection
:members:
:undoc-members:
:show-inheritance:
libp2p.security.noise.patterns module
-------------------------------------
.. automodule:: libp2p.security.noise.patterns
:members:
:undoc-members:
:show-inheritance:
libp2p.security.noise.transport module
--------------------------------------
.. automodule:: libp2p.security.noise.transport
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: libp2p.security.noise
:members:
:undoc-members:
:show-inheritance:

View File

@ -6,8 +6,9 @@ Subpackages
.. toctree:: .. toctree::
libp2p.security.insecure libp2p.security.insecure
libp2p.security.secio libp2p.security.noise
libp2p.security.secio
Submodules Submodules
---------- ----------
@ -16,55 +17,55 @@ libp2p.security.base\_session module
------------------------------------ ------------------------------------
.. automodule:: libp2p.security.base_session .. automodule:: libp2p.security.base_session
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.security.base\_transport module libp2p.security.base\_transport module
-------------------------------------- --------------------------------------
.. automodule:: libp2p.security.base_transport .. automodule:: libp2p.security.base_transport
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.security.exceptions module libp2p.security.exceptions module
--------------------------------- ---------------------------------
.. automodule:: libp2p.security.exceptions .. automodule:: libp2p.security.exceptions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.security.secure\_conn\_interface module libp2p.security.secure\_conn\_interface module
---------------------------------------------- ----------------------------------------------
.. automodule:: libp2p.security.secure_conn_interface .. automodule:: libp2p.security.secure_conn_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.security.secure\_transport\_interface module libp2p.security.secure\_transport\_interface module
--------------------------------------------------- ---------------------------------------------------
.. automodule:: libp2p.security.secure_transport_interface .. automodule:: libp2p.security.secure_transport_interface
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
libp2p.security.security\_multistream module libp2p.security.security\_multistream module
-------------------------------------------- --------------------------------------------
.. automodule:: libp2p.security.security_multistream .. automodule:: libp2p.security.security_multistream
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Module contents Module contents
--------------- ---------------
.. automodule:: libp2p.security .. automodule:: libp2p.security
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance: