Skip to content

Commit

Permalink
Add docs on installing nb-tester (#2499)
Browse files Browse the repository at this point in the history
We already include docs on the config file and CLI, just need to explain
how to install.

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
  • Loading branch information
frankharkins and Eric-Arellano authored Dec 17, 2024
1 parent 8f45137 commit a882131
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions scripts/nb-tester/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,26 @@
A tool to execute notebooks for testing, with certain features useful for
notebooks that run jobs on IBM Quantum backends.

## Installing

To install, run the following command:

```
pip install git+https://github.com/Qiskit/documentation.git@main#subdirectory=scripts/nb-tester
```

> [!NOTE]
> If adding this package as a dependency, change `main` to point to a specific
> commit. For example:
> ```
> git+https://github.com/Qiskit/documentation.git@91bce99173f46be985698cc78ec4521856bf83b6#subdirectory=scripts/nb-tester
> ```
> This means changes to this repository won't break your tests. You can update
> the commit when you're ready to pull in our changes.
If adding this as a dependency to a `tox.ini` file, escape the `#` with a
backslash like this: `\#`.
## Basic usage
To use this tool, just run the `test-docs-notebooks` command, followed by a
Expand Down

0 comments on commit a882131

Please sign in to comment.