varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2025-12-31 20:36:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

display example code and usage instructions in docs

Browse Source
This commit is contained in:
pacrob
2024-05-19 12:37:25 -06:00
committed by Paul Robinson
parent c770a05d23
commit 7de6cbaab0
8 changed files with 48 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/examples.chat.rst
View File

@ -1,21 +1,19 @@
examples.chat package
=====================
Chat Demo
=========
Submodules
----------
Copy the code below into a file called ``chat.py``.
Install dependencies, preferably in a virtual environment, with:
examples.chat.chat module
-------------------------
.. code-block:: bash
.. automodule:: examples.chat.chat
:members:
:undoc-members:
:show-inheritance:
python -m pip install libp2p
Module contents
---------------
.. automodule:: examples.chat
:members:
:undoc-members:
:show-inheritance:
Run the demo with ``python chat.py`` and copy the output.
Open a second terminal, navigate to the folder that contains ``chat.py``, then paste
and run the copied line.
.. literalinclude:: ../examples/chat/chat.py
:language: python
:linenos: