display example code and usage instructions in docs

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

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:

18
docs/examples.echo.rst Normal file
View File

@ -0,0 +1,18 @@
Echo Demo
=========
Copy the code below into a file called ``demo.py``.
Install dependencies, preferably in a virtual environment, with:
.. code-block:: bash
python -m pip install libp2p
Run the demo with ``python echo.py`` and copy the output.
Open a second terminal, navigate to the folder that contains ``echo.py``, then paste
and run the copied line.
.. literalinclude:: ../examples/echo/echo.py
:language: python
:linenos:

View File

@ -1,12 +1,17 @@
examples package
================
Examples
========
Subpackages
-----------
These are functional demonstrations of aspects of the library. They are
intended to be run as scripts, and are not intended to be used as part of
another application.
Example Scripts
---------------
.. toctree::
examples.chat
examples.echo
Module contents
---------------