rev-ng
/
sbeam
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documenting cli tool

This commit is contained in:
jpk 2019-10-02 08:52:45 +02:00
parent 813ea960f5
commit ac3d398811
4 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
source/conf.py
View File

@ -37,6 +37,7 @@ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.todo', 'sphinx.ext.todo',
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',
'sphinx_click.ext',
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.

5
source/index.rst
View File

@ -3,13 +3,14 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to SuperBeam CLI's documentation! Welcome to SuperBeam documentation!
========================================= ===================================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
sbeam
SuperBeam SuperBeam
SuperBeam.RequestHandlers SuperBeam.RequestHandlers

10
source/sbeam.rst Normal file
View File

@ -0,0 +1,10 @@
SuperBeam CLI Tool
==================
SuperBeam CLI provides an interface to serve and receive files to and from
SuperBeam clients. The SuperBeam CLI supports the native Android application.
.. click:: sbeam:cli
:prog: sbeam
:show-nested:

11
src/sbeam.py
View File

@ -150,14 +150,3 @@ def tui():
if __name__ == '__main__': if __name__ == '__main__':
cli() cli()
# to_download = 0
# superlist = get_superlist()
# try:
# for item in superlist:
# to_download += int(item.split('||')[1])
# except IndexError:
# print(f'Download stream contains {len(superlist) - 1} items.')
# finally:
# print(f'Target download size is {to_download} bytes.')
# save_stream('data.gz')
# split_stream('data.gz', 'received', superlist)