docs: enhance getting started guide with example output and image reference
Some checks failed
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 22s
Build Project / Build Project (3.10) (pull_request) Failing after 3m19s
Test with tox / Test with tox (3.11) (pull_request) Failing after 6m16s
Test with tox / Test with tox (3.10) (pull_request) Failing after 11m32s
Build Project / Build Project (3.11) (pull_request) Successful in 12m4s
Build Project / Build Project (3.12) (pull_request) Successful in 12m2s
Test with tox / Test with tox (3.12) (pull_request) Successful in 12m26s
Some checks failed
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 22s
Build Project / Build Project (3.10) (pull_request) Failing after 3m19s
Test with tox / Test with tox (3.11) (pull_request) Failing after 6m16s
Test with tox / Test with tox (3.10) (pull_request) Failing after 11m32s
Build Project / Build Project (3.11) (pull_request) Successful in 12m4s
Build Project / Build Project (3.12) (pull_request) Successful in 12m2s
Test with tox / Test with tox (3.12) (pull_request) Successful in 12m26s
This commit is contained in:
parent
a4cd158b2a
commit
9a304faa00
|
|
@ -413,6 +413,12 @@ Device selection (``--device``) is optional if only one device is detected. Exac
|
||||||
ria view capture.npy --type full --title "Test Capture" --format pdf
|
ria view capture.npy --type full --title "Test Capture" --format pdf
|
||||||
ria view capture.npy --show --no-save
|
ria view capture.npy --show --no-save
|
||||||
ria view old.npy --legacy --type simple
|
ria view old.npy --legacy --type simple
|
||||||
|
ria view recordings\qam64_35.npy --type simple
|
||||||
|
|
||||||
|
.. figure:: ../images/qam64_35.png
|
||||||
|
:alt: Example output of ria view recordings\qam64_35.npy --type simple
|
||||||
|
|
||||||
|
Output of ``ria view recordings\qam64_35.npy --type simple``
|
||||||
|
|
||||||
|
|
||||||
.. _cmd-annotate:
|
.. _cmd-annotate:
|
||||||
|
|
|
||||||
|
|
@ -32,16 +32,15 @@ def extract_metadata_fields(metadata):
|
||||||
|
|
||||||
|
|
||||||
def set_path(output_path):
|
def set_path(output_path):
|
||||||
split_path = output_path.split("/")
|
path = pathlib.Path(output_path)
|
||||||
|
|
||||||
if len(split_path) == 1:
|
# If only filename provided (no directory), use default 'images' folder
|
||||||
folder = "images"
|
if len(path.parts) == 1:
|
||||||
file = split_path[0]
|
folder = pathlib.Path("images")
|
||||||
elif len(split_path) > 2:
|
file = path.name
|
||||||
file = split_path[-1]
|
|
||||||
folder = "/".join(split_path[:-1])
|
|
||||||
else:
|
else:
|
||||||
folder, file = split_path
|
folder = path.parent
|
||||||
|
file = path.name
|
||||||
|
|
||||||
split_file = file.split(".")
|
split_file = file.split(".")
|
||||||
if len(split_file) == 2:
|
if len(split_file) == 2:
|
||||||
|
|
@ -53,5 +52,5 @@ def set_path(output_path):
|
||||||
extension = "png"
|
extension = "png"
|
||||||
file = file + ".png"
|
file = file + ".png"
|
||||||
|
|
||||||
pathlib.Path(folder).mkdir(parents=True, exist_ok=True)
|
folder.mkdir(parents=True, exist_ok=True)
|
||||||
return "/".join([folder, file]), extension
|
return str(folder / file), extension
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user