Skip to content

Commit

Permalink
deploy: 38ae2fb
Browse files Browse the repository at this point in the history
  • Loading branch information
tfcollins committed Sep 23, 2024
1 parent f74672d commit 39da5a1
Show file tree
Hide file tree
Showing 25 changed files with 683 additions and 268 deletions.
32 changes: 32 additions & 0 deletions main/_sources/cli.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Command Line Interface Tools

The following command line tools are available in the when the optional `cli` dependency is installed.

```bash
pip install pybench[cli]
```

There are two command line tools available:
- [`pybenchiio`](#pybenchiiocli) - A command line tool for interfacing with libiio devices.
- [`pybench`](#pybenchcli) - A command line tool for querying VISA based instruments.


(pybenchiiocli)=
```{eval-rst}
.. click:: bench.cli.iiotools:cli
:prog: pybenchiio
:nested: full


```

---

(pybenchcli)=
```{eval-rst}
.. click:: bench.cli.visatools:cli
:prog: pybench
:nested: full


```
1 change: 1 addition & 0 deletions main/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The module is designed to also support testing frameworks, such as pytest, and t
install.md
example_usage
instruments/index
cli


.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion main/_static/scripts/furo.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion main/_static/scripts/furo.js.map

Large diffs are not rendered by default.

Loading

0 comments on commit 39da5a1

Please sign in to comment.