Skip to content

Commit

Permalink
Documentation fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
innot committed Jul 18, 2022
1 parent 34fe545 commit 9426aa1
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
24 changes: 22 additions & 2 deletions docs/source/examples.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,33 @@
Examples
========

Go to the source code by clicking on the headline.
The examples can be found on github in the
`examples <https://github.com/innot/argparseDecorator/tree/master/examples>`_ folder.
You can go directly to the source file by clicking on the title of the example.

`simple_cli.py <https://github.com/innot/argparseDecorator/blob/master/examples/simple_cli.py>`_
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

This is a very simple cli that takes input from stdin. It has a few sample commands that show a few basic features of
the argparseDecorator.


`simple_asyncio_demo.py <https://github.com/innot/argparseDecorator/blob/master/examples/simple_asyncio_demo.py>`_
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

A very small sample to test using argparseDecorator in an asyncio context.


`ssh_cli.py <https://github.com/innot/argparseDecorator/blob/master/examples/ssh_cli.py>`_
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

is a more involved demo that shows how argparseDecorator can be used to create a CLI that can be accessed remotly via
ssh.

Full Documentation
------------------

.. automodule:: ssh_cli
:members:
:undoc-members:
:show-inheritance:

2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ the argparseDecorator.

### 2. simple_asyncio_demo.py

A very small sample to test using argparseDecorator in am asyncio context.
A very small sample to test using argparseDecorator in an asyncio context.

### 3. ssh_cli.py

Expand Down

0 comments on commit 9426aa1

Please sign in to comment.