Create frame for friendlier docs, rebuild autodocs

2026-02-12 16:10:57 +00:00 · 2024-03-23 17:41:07 -06:00
parent 5eb98a2288
commit 9af46b679a
35 changed files with 456 additions and 411 deletions
--- a/docs/code_of_conduct.rst
+++ b/docs/code_of_conduct.rst
@ -0,0 +1,12 @@
+Code of Conduct
+===============
+
+The libp2p project operates under the `IPFS Code of Conduct <https://github.com/ipfs/community/blob/master/code-of-conduct.md>`_
+
+tl;dr:
+
+- Be respectful.
+- We're here to help: abuse@ipfs.io
+- Abusive behavior is never tolerated.
+- Violations of this code may result in swift and permanent expulsion from the IPFS [and libp2p] community.
+- "Too long, didn't read" is not a valid excuse for not knowing what is in this document.
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@ -0,0 +1,4 @@
+Contributing
+============
+
+TODO - instructions for contributing
--- a/docs/examples.chat.rst
+++ b/docs/examples.chat.rst
@ -12,7 +12,6 @@ examples.chat.chat module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/index.rst
+++ b/docs/index.rst
@ -7,15 +7,24 @@ Contents
 --------

 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 1
+    :caption: General

-    libp2p
+    introduction
+    quickstart
    release_notes
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: py-libp2p
+
    examples
+    API <libp2p>

+.. toctree::
+    :maxdepth: 1
+    :caption: Community

-Indices and tables
------------------
-
-* :ref:`genindex`
-* :ref:`modindex`
+    contributing
+    code_of_conduct
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@ -0,0 +1,11 @@
+Introduction
+============
+
+py-libp2p is the Python implementation of the libp2p networking stack.
+It hopes to someday be fully compatible with other implementations of libp2p.
+
+This project is still in its early stages, and is not yet ready for production use.
+
+Further Reading
+---------------
+`libp2p main site <https://libp2p.io/>`_
--- a/docs/libp2p.crypto.pb.rst
+++ b/docs/libp2p.crypto.pb.rst
@ -12,7 +12,6 @@ libp2p.crypto.pb.crypto\_pb2 module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.crypto.rst
+++ b/docs/libp2p.crypto.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.crypto.pb

@ -83,7 +84,6 @@ libp2p.crypto.serialization module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.host.rst
+++ b/docs/libp2p.host.rst
@ -52,7 +52,6 @@ libp2p.host.routed\_host module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.identity.identify.pb.rst
+++ b/docs/libp2p.identity.identify.pb.rst
@ -12,7 +12,6 @@ libp2p.identity.identify.pb.identify\_pb2 module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.identity.identify.rst
+++ b/docs/libp2p.identity.identify.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.identity.identify.pb

@ -19,7 +20,6 @@ libp2p.identity.identify.protocol module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.identity.rst
+++ b/docs/libp2p.identity.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.identity.identify

--- a/docs/libp2p.io.rst
+++ b/docs/libp2p.io.rst
@ -28,6 +28,14 @@ libp2p.io.msgio module
   :undoc-members:
   :show-inheritance:

+libp2p.io.trio module
+---------------------
+
+.. automodule:: libp2p.io.trio
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 libp2p.io.utils module
 ----------------------

@ -36,7 +44,6 @@ libp2p.io.utils module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.network.connection.rst
+++ b/docs/libp2p.network.connection.rst
@ -44,7 +44,6 @@ libp2p.network.connection.swarm\_connection module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.network.rst
+++ b/docs/libp2p.network.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.network.connection
   libp2p.network.stream
@ -44,7 +45,6 @@ libp2p.network.swarm module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.network.stream.rst
+++ b/docs/libp2p.network.stream.rst
@ -28,7 +28,6 @@ libp2p.network.stream.net\_stream\_interface module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.peer.rst
+++ b/docs/libp2p.peer.rst
@ -68,7 +68,6 @@ libp2p.peer.peerstore\_interface module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.protocol_muxer.rst
+++ b/docs/libp2p.protocol_muxer.rst
@ -60,7 +60,6 @@ libp2p.protocol\_muxer.multiselect\_muxer\_interface module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.pubsub.pb.rst
+++ b/docs/libp2p.pubsub.pb.rst
@ -12,7 +12,6 @@ libp2p.pubsub.pb.rpc\_pb2 module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.pubsub.rst
+++ b/docs/libp2p.pubsub.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.pubsub.pb

@ -75,6 +76,14 @@ libp2p.pubsub.subscription module
   :undoc-members:
   :show-inheritance:

+libp2p.pubsub.typing module
+---------------------------
+
+.. automodule:: libp2p.pubsub.typing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 libp2p.pubsub.validators module
 -------------------------------

@ -83,7 +92,6 @@ libp2p.pubsub.validators module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.routing.rst
+++ b/docs/libp2p.routing.rst
@ -1,7 +1,6 @@
 libp2p.routing package
 ======================

-
 Submodules
 ----------

@ -13,7 +12,6 @@ libp2p.routing.interfaces module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.rst
+++ b/docs/libp2p.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.crypto
   libp2p.host
@ -47,7 +48,6 @@ libp2p.utils module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.security.insecure.pb.rst
+++ b/docs/libp2p.security.insecure.pb.rst
@ -12,7 +12,6 @@ libp2p.security.insecure.pb.plaintext\_pb2 module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.security.insecure.rst
+++ b/docs/libp2p.security.insecure.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.security.insecure.pb

@ -19,7 +20,6 @@ libp2p.security.insecure.transport module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.security.noise.pb.rst
+++ b/docs/libp2p.security.noise.pb.rst
@ -12,7 +12,6 @@ libp2p.security.noise.pb.noise\_pb2 module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.security.noise.rst
+++ b/docs/libp2p.security.noise.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.security.noise.pb

@ -51,7 +52,6 @@ libp2p.security.noise.transport module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.security.rst
+++ b/docs/libp2p.security.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.security.insecure
   libp2p.security.noise
@ -45,6 +46,14 @@ libp2p.security.secure\_conn\_interface module
   :undoc-members:
   :show-inheritance:

+libp2p.security.secure\_session module
+--------------------------------------
+
+.. automodule:: libp2p.security.secure_session
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 libp2p.security.secure\_transport\_interface module
 ---------------------------------------------------

@ -61,7 +70,6 @@ libp2p.security.security\_multistream module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.security.secio.pb.rst
+++ b/docs/libp2p.security.secio.pb.rst
@ -12,7 +12,6 @@ libp2p.security.secio.pb.spipe\_pb2 module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.security.secio.rst
+++ b/docs/libp2p.security.secio.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.security.secio.pb

@ -27,7 +28,6 @@ libp2p.security.secio.transport module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.stream_muxer.mplex.rst
+++ b/docs/libp2p.stream_muxer.mplex.rst
@ -44,7 +44,6 @@ libp2p.stream\_muxer.mplex.mplex\_stream module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.stream_muxer.rst
+++ b/docs/libp2p.stream_muxer.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.stream_muxer.mplex

@ -35,7 +36,6 @@ libp2p.stream\_muxer.muxer\_multistream module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.tools.pubsub.rst
+++ b/docs/libp2p.tools.pubsub.rst
@ -28,7 +28,6 @@ libp2p.tools.pubsub.utils module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.tools.rst
+++ b/docs/libp2p.tools.rst
@ -5,11 +5,10 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.tools.pubsub

-The interop module is left out for now, because of the extra dependencies it requires.
-
 Submodules
 ----------

@ -37,7 +36,6 @@ libp2p.tools.utils module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.transport.rst
+++ b/docs/libp2p.transport.rst
@ -5,6 +5,7 @@ Subpackages
 -----------

 .. toctree::
+   :maxdepth: 4

   libp2p.transport.tcp

@ -51,7 +52,6 @@ libp2p.transport.upgrader module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/libp2p.transport.tcp.rst
+++ b/docs/libp2p.transport.tcp.rst
@ -12,7 +12,6 @@ libp2p.transport.tcp.tcp module
   :undoc-members:
   :show-inheritance:

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

--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@ -0,0 +1,4 @@
+Quickstart
+================
+
+TODO - add quickstart instructions