From 4620544d4578eeb300f0431bf6eb94f62b946a05 Mon Sep 17 00:00:00 2001 From: mhchia Date: Sat, 15 Feb 2020 12:35:36 +0800 Subject: [PATCH] Noise: fix docs --- docs/libp2p.security.noise.pb.rst | 22 +++++++++++++++ docs/libp2p.security.noise.rst | 45 +++++++++++++++++++++++++++++ docs/libp2p.security.rst | 47 ++++++++++++++++--------------- 3 files changed, 91 insertions(+), 23 deletions(-) create mode 100644 docs/libp2p.security.noise.pb.rst create mode 100644 docs/libp2p.security.noise.rst diff --git a/docs/libp2p.security.noise.pb.rst b/docs/libp2p.security.noise.pb.rst new file mode 100644 index 0000000..1088136 --- /dev/null +++ b/docs/libp2p.security.noise.pb.rst @@ -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: diff --git a/docs/libp2p.security.noise.rst b/docs/libp2p.security.noise.rst new file mode 100644 index 0000000..a6aaa49 --- /dev/null +++ b/docs/libp2p.security.noise.rst @@ -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: diff --git a/docs/libp2p.security.rst b/docs/libp2p.security.rst index de60977..32dd329 100644 --- a/docs/libp2p.security.rst +++ b/docs/libp2p.security.rst @@ -6,8 +6,9 @@ Subpackages .. toctree:: - libp2p.security.insecure - libp2p.security.secio + libp2p.security.insecure + libp2p.security.noise + libp2p.security.secio Submodules ---------- @@ -16,55 +17,55 @@ libp2p.security.base\_session module ------------------------------------ .. automodule:: libp2p.security.base_session - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.security.base\_transport module -------------------------------------- .. automodule:: libp2p.security.base_transport - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.security.exceptions module --------------------------------- .. automodule:: libp2p.security.exceptions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.security.secure\_conn\_interface module ---------------------------------------------- .. automodule:: libp2p.security.secure_conn_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.security.secure\_transport\_interface module --------------------------------------------------- .. automodule:: libp2p.security.secure_transport_interface - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: libp2p.security.security\_multistream module -------------------------------------------- .. automodule:: libp2p.security.security_multistream - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: libp2p.security - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: