Documenting cli tool
This commit is contained in:
parent
813ea960f5
commit
ac3d398811
|
@ -37,6 +37,7 @@ extensions = [
|
|||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.todo',
|
||||
'sphinx.ext.napoleon',
|
||||
'sphinx_click.ext',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
|
|
|
@ -3,13 +3,14 @@
|
|||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to SuperBeam CLI's documentation!
|
||||
=========================================
|
||||
Welcome to SuperBeam documentation!
|
||||
===================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
sbeam
|
||||
SuperBeam
|
||||
SuperBeam.RequestHandlers
|
||||
|
||||
|
|
|
@ -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
11
src/sbeam.py
|
@ -150,14 +150,3 @@ def tui():
|
|||
|
||||
if __name__ == '__main__':
|
||||
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)
|
||||
|
|
Loading…
Reference in New Issue