Docs cleanup - framework for filling in later

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: [email protected]
+- 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.

docs/contributing.rst

@@ -0,0 +1,4 @@
+Contributing
+============
+
+TODO - instructions for contributing

docs/examples.chat.rst

@@ -8,15 +8,14 @@ examples.chat.chat module
 -------------------------
 
 .. automodule:: examples.chat.chat
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------
 
 .. automodule:: examples.chat
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/index.rst

@@ -7,15 +7,24 @@ Contents
 --------
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 1
+    :caption: General
 
-    libp2p
+    introduction
+    quickstart
     release_notes
-    examples
 
 
-Indices and tables
-------------------
+.. toctree::
+    :maxdepth: 1
+    :caption: py-libp2p
+
+    examples
+    API <libp2p>
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Community
 
-* :ref:`genindex`
-* :ref:`modindex`
+    contributing
+    code_of_conduct

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/>`_

docs/libp2p.crypto.pb.rst

@@ -8,15 +8,14 @@ libp2p.crypto.pb.crypto\_pb2 module
 -----------------------------------
 
 .. automodule:: libp2p.crypto.pb.crypto_pb2
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------
 
 .. automodule:: libp2p.crypto.pb
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/libp2p.crypto.rst

@@ -5,8 +5,9 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
-    libp2p.crypto.pb
+   libp2p.crypto.pb
 
 Submodules
 ----------
@@ -15,79 +16,78 @@ libp2p.crypto.authenticated\_encryption module
 ----------------------------------------------
 
 .. automodule:: libp2p.crypto.authenticated_encryption
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.crypto.ecc module
 ------------------------
 
 .. automodule:: libp2p.crypto.ecc
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.crypto.ed25519 module
 ----------------------------
 
 .. automodule:: libp2p.crypto.ed25519
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.crypto.exceptions module
 -------------------------------
 
 .. automodule:: libp2p.crypto.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.crypto.key\_exchange module
 ----------------------------------
 
 .. automodule:: libp2p.crypto.key_exchange
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.crypto.keys module
 -------------------------
 
 .. automodule:: libp2p.crypto.keys
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.crypto.rsa module
 ------------------------
 
 .. automodule:: libp2p.crypto.rsa
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.crypto.secp256k1 module
 ------------------------------
 
 .. automodule:: libp2p.crypto.secp256k1
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.crypto.serialization module
 ----------------------------------
 
 .. automodule:: libp2p.crypto.serialization
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------
 
 .. automodule:: libp2p.crypto
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/libp2p.host.rst

@@ -8,55 +8,54 @@ libp2p.host.basic\_host module
 ------------------------------
 
 .. automodule:: libp2p.host.basic_host
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.host.defaults module
 ---------------------------
 
 .. automodule:: libp2p.host.defaults
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.host.exceptions module
 -----------------------------
 
 .. automodule:: libp2p.host.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.host.host\_interface module
 ----------------------------------
 
 .. automodule:: libp2p.host.host_interface
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.host.ping module
 -----------------------
 
 .. automodule:: libp2p.host.ping
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 libp2p.host.routed\_host module
 -------------------------------
 
 .. automodule:: libp2p.host.routed_host
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------
 
 .. automodule:: libp2p.host
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/libp2p.identity.identify.pb.rst

@@ -8,15 +8,14 @@ libp2p.identity.identify.pb.identify\_pb2 module
 ------------------------------------------------
 
 .. automodule:: libp2p.identity.identify.pb.identify_pb2
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------
 
 .. automodule:: libp2p.identity.identify.pb
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/libp2p.identity.identify.rst

@@ -5,8 +5,9 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
-    libp2p.identity.identify.pb
+   libp2p.identity.identify.pb
 
 Submodules
 ----------
@@ -15,15 +16,14 @@ libp2p.identity.identify.protocol module
 ----------------------------------------
 
 .. automodule:: libp2p.identity.identify.protocol
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------
 
 .. automodule:: libp2p.identity.identify
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/libp2p.identity.rst

@@ -5,13 +5,14 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
-    libp2p.identity.identify
+   libp2p.identity.identify
 
 Module contents
 ---------------
 
 .. automodule:: libp2p.identity
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance: